网上书店网站建设规划书推广文案怎么写吸引人

原标题：Java Restful API 文档生成工具 smart-doc | 软件推介

授权协议：Apache-2.0

开发语言：Java

软件作者：上官胡闹

背景

在当今各种盛行的前后端分离、restful service开发过程中，接口文档是必不 可少的。对于前后端分离的开发中，后端开发需要将接口写好后需要告诉前端工程师接口的请求参数、响应示例等重要信息，而对于对外暴露的restful接口服务，我们提供接口也是需要具备相同的接口文档的。

但是对于后端工程师来讲，写接口文档将变成一个很大的工作量，虽然现在有类似apidoc、swagger这样的主流接口文档生成工具，但是如果实际用过，会发现这些工具不能满足实际需求，这里拿swagger为例，这个工具最大的优点能是提供在线的api文档，但是它天生就有很强的代码侵入性，要得到一个基本满足需求的api接口文档，必须在代码中使用swagger自定义的注解。这其实给开发人员增加学习成本和工作量，并且就算你使用大量的注解，有许多接口还是无法满足。因此不得不去做一次接口文档工具重新启航探索，smart-doc应允而生，用代码去探路，消除繁杂的注解，发现天下没有难写接口文档。

简介

smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照java标准注释的写就能得到一个标准的markdown接口文档。如果你已经厌倦了swagger等文档工具的注解和强侵入污染，那请拥抱smart-doc吧！

功能特性

零注解、零学习成本、只需要写java原生注释

基于源代码接口定义自动推导，强大的返回结构推导

支持springmvc、springboot

目前支持javabean上定义的部分fastjson和jackson注解

支持javabean上基于jsr303参数检验判断参数是否为必须

对json请求参数的接口能够自动推导生成模拟json参数

对一些常用字段定义能够自动生成有效的模拟值

支持生成json返回值示例

支持从项目外部加载源代码来生成字段注释

支持将错误码列表和全接口生成合并到一个markdown中

一款代码注解检测工具，明眼leader都知道接口文档直接反馈出注释情况

效率成效

直接生成模拟请求参数，提升了团队里的前端和测试的工作效率，试想你让他们去编写json请求参数，如果你不写，鬼知道是什么样。

后端开发只需专注业务和写好标准注释，无需引入额外注解，无需自己编写请求参数示例和响应示例。

接口文档更加标准化

缺点

由于基于源代码分析生成文档，因此无法生成在线文档，需要结合地方markdown文档管理工具来管理。

由于源代码分析难度很大，针对很多代码存在潜在的大量的bug.

对泛型返回接口需要明确定义泛型定义，否则无法推导

用例

定义bean

定义接口

启动文档生成

添加用户

URL:http://localhost:8080/user/add

Type: post

Content-Type: application/json; charset=utf-8

Request-parameters:

Request-example:

Response-fields:

Response-example:

demo地址：https://github.com/shalousun/api-doc-test

未来定义

修改源代码解析的众多的bug

收集使用者的建议，提供非json请求参数的请求示例

收集使用者一些新增功能建议，增加一些必须功能。

知名用户

一加【oneplus】

iflytek

给使用者的建议

smart-doc虽然可以关闭注解检测，好的规范更容易让项目变得更容易维护

smart-doc的出发的目标不是仅仅为书写接口的开发人员自己测试接口服务的，而是希望导出的文档能够用极少的变更就能做接口服务对接文档。

目前不提供ui界面主要是我们不认同swagger等类似直接集成到项目的形式，更想将文档数据一键导入小幺鸡、CrapApi等企业级接口文档管理中心【暂不支持】。

smart-doc主要目的是为了减少接口文档书写和造测试模拟数据Markdown工具推荐

smart-doc目前能够支持将文档合并到一个markdown文件，因此你可以使用Typora工具将markdown转换成pdf、word或者是html文档。返回搜狐，查看更多

责任编辑：