文档规范
豆子前端
技术现学现卖,公众号同名
展开
-
记一次后端接口开发文档的组织过程(elasticsearch)
前言: 沟通是有成本的,尤其是项目成员技术差距很大的时候,良好的代码编写必须是以文档驱动的,这是领悟软件工程精髓的必经之路。 记一次小组开发文档的组织,虽然我本人组织得不伦不类,但是也必须得给项目组成员写好示例,分好工,否则到头来只会累坏自己,成员也没有参与感。-----------------------------正文分割线-----------------------文章目录要求参考json一、moocgle主页(xxx负责)1.网站功能2.接口设计2.1 课程搜索2.2 各大moo原创 2020-07-05 18:15:30 · 813 阅读 · 0 评论 -
RESTful API入门学习笔记
文章目录参考资料1. 什么是RESTful风格?1.1 REST全称1.1 实例说明2. RESTful的概念2.1 资源与URI2.2 统一资源接口2.2.1 GET2.2.2 POST2.2.3 PUT2.2.4 DELETE2.3 资源的表述2.3.1 json格式2.3.2 XML格式2.3.3 常用的设计2.3.3.1 在URI里边带上版本号2.3.3.2 使用URI后缀来区分表述格式...原创 2020-04-28 19:14:47 · 1228 阅读 · 0 评论 -
实用Typora快捷键
实用Typora快捷键1. 字体编辑1.1 大小: 大小:ctr + 数字 或 ctr + 加减号 或 ###1.2 加粗 加粗:ctr + b1.3 倾斜 倾斜:ctr + i1.4 下划线 下划线:ctr + u1.5 删除线 删除线:alt + shift + 51.6 上标 上标 :^ + ...原创 2019-07-02 10:09:44 · 1139 阅读 · 0 评论 -
markdown基础语法
更多详情: https://www.jianshu.com/p/191d1e21f7ed一、标题在想要设置为标题的文字前面加#来表示一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。注:标准语法一般在#后跟个空格再写文字,貌似简书不加空格也行。示例:# 这是一级标题## 这是二级标题### 这是三级标题#### 这是四级标题##### 这是五级标题###### 这是...原创 2019-07-02 10:22:25 · 137 阅读 · 0 评论