linux cpu占用率如何看
471
2023-02-04
api接口文档生成（自动生成api接口文档的框架）
本篇文章给大家谈谈api接口文档生成，以及自动生成api接口文档的框架对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。
今天给各位分享api接口文档生成的知识，其中也会对自动生成api接口文档的框架进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！
本文目录一览：
java api接口文档怎么编写？
Java语言提供了一种强大的注释形式：文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）作为结尾，中间部分全部都是文档注释，会被提取到API文档中。
自行搜索一下javadoc即可，示例如下：
1234567891011121314151617181920212223242526272829/** * 类描述 * * @author 作者 * @version 版本 */public class DemoClass { /** * 内部属性：name */ private String name; /** * Setter方法 * @return name */ public String getName() { return name; } /** * Getter方法 * @param name */ public void setName(String name) { this.name = name; } }
如何优雅的“编写”api接口文档
一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据，可与PUT互换，语义上PUT支持幂等
PUT
用于新增数据，可与POST互换，语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成，有分隔符隔开
4. HTTP Body
描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例：
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样，需要描述请清除数据的类型。
另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例（重点都用红笔圈出来，记牢了）：
五、接口工具
推荐使用的是http://docway.net（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
SpringBoot2基于Swagger2生成离线Api文档
Github : https://github.com/ChaselX/springboot-swagger2-offline-api-doc
Gitee : https://gitee.com/chasel96/springboot-swagger2-offline-api-doc
个人觉得 旧版的配置简单许多 ，新版的配置按照官方demo的配置来做还是复杂了很多
配置到Springboot项目中以后，在项目打包的时候便会通过单元测试在指定的目录生成被 官方 称为staticdocs的离线文档
该篇博文引用的依赖都要引入，Spring Rest Docs的依赖spring-restdocs-mockmvc，离线文档的依赖springfox-staticdocs，因为要在单元测试的时候生成文档，所以需要再加测试相关的spring-boot-starter-test。
asciidoctor-maven-plugin 插件会把Asciidoc格式文件转成HTML5格式输出。
这个类包含两个方法，TestApi()是用来生成例子，test()用来生成Asciidoc的文档。生成例子用到了spring-restdocs-mockmvc，每一个API都要进行单元测试才能生成相应的文档片段（snippets），生成的结果如图：
生成完整的Asciidoc文档用到了 Swagger2MarkupConverter ，第一步先获取在线版本的文档并保存到文件 swagger.json 中，第二步把 swagger.json 和之前的例子snippets整合并保存为Asciidoc格式的完整文档。生成结果如图：
通过配置类定义一些文档相关的信息
路径：项目名/docs/asciidoc/index.adoc
利用前面配置的maven插件，只需要执行打包就可以生成相应的文档，如图：
该篇博文引用的依赖都要引入，Spring Rest Docs的依赖spring-restdocs-mockmvc，离线文档的依赖springfox-staticdocs，因为要在单元测试的时候生成文档，所以需要再加测试相关的spring-boot-starter-test。
asciidoctor-maven-plugin 插件会把Asciidoc格式文件转成HTML5格式输出。
这个类包含两个方法，TestApi()是用来生成例子，createSpringfoxSwaggerJson()用来生成Asciidoc的文档。生成例子用到了spring-restdocs-mockmvc，每一个API都要进行单元测试才能生成相应的文档片段（snippets），生成的结果如图：
生成完整的Asciidoc文档用到了 Swagger2MarkupConverter ，第一步先获取在线版本的文档并保存到文件 swagger.json 中，第二步把 swagger.json 和之前的例子snippets整合并保存为Asciidoc格式的完整文档。生成结果如图：
通过配置类定义一些文档相关的信息
在resources目录下创建一个名为logback.xml的配置文件，使用LogstashEncoder作为Default Log Encoder
路径：项目名src/docs/asciidoc/index.adoc
利用前面配置的maven插件，只需要执行打包就可以生成相应的文档，如图：
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
相关文章
发表评论
暂时没有评论，来抢沙发吧~