通用App接口定义文档规范.doc下载

weixin_39821526 2022-04-28 09:08:37

通用App接口定义文档规范.doc , 相关下载链接：https://download.csdn.net/download/pyhm63/29152464?utm_source=bbsseo

...全文

17 回复打赏收藏转发到动态举报

写回复

回复

切换为时间正序

请发表友善的回复…

发表回复

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。零注解、零学习成本、只需要写标准JAVA注释。

接口文档Smart-Doc

摘要 1 前言 2 AS 规范 3 命名规范 4 代码样式规范 5 资源文件规范 6 版本统一规范 7 第三方库规范 8 注释规范 9 测试规范 10 其他的一些规范 1 前言为了有利于项目维护、增强代码可读性、提升 Code Review 效率以及规范团队安卓开发，故提出以下安卓开发规范，该规范结合本人多年的开发经验并吸取多家之精华，可谓是本人的呕心沥血之作，称其为当...

在前后端分离项目中我们一般需要在请求接口时设置一个请求头，如token，Authorization等...后端根据请求头判断是否为系统合法用户，目前smart-doc也对其提供了支持。在smart-doc配置文件"requestHeaders": [ //设置请求头，没有需求可以不设置"name": "token",//请求头名称"type": "string",//请求头类型"desc": "自定义请求头 - token",//请求头描述信息。

之前我在SpringBoot老鸟系列中专门花了大量的篇幅详细介绍如何集成Swagger，以及如何对Swagger进行扩展让其支持接口参数分组功能。详情可见：SpringBoot 如何生成接口文档，老鸟们都这么玩的！可是当我接触到另一个接口文档工具smart-doc后，我觉得它比Swagger更适合集成在项目中，更适合老鸟们。今天我们就来介绍一下smart-doc组件的使用，作为对老鸟系列文章的一个补充。 swagger vs smart-doc 首先我们先看一下Swagger组件目前存在的主要问

下载资源悬赏专区

13,654

社区成员

12,574,394

社区内容

发帖

与我相关

我的任务

其他技术论坛（原bbs）

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

暂无公告

试试用AI创作助手写篇文章吧

+ 用AI写文章