smart-doc is a java restful api documentation generation tool, smart-doc subvert the traditional similar swagger that extensive use of annotations invasive method to generate an implementation document. smart-doc full source code analysis to generate interfaces based interface documentation, fully achieve zero notes invasion, you only need to follow to write java standard comments can get a standard markdown interface documentation. If you are tired of the notes and other documentation tools swagger and strong invasion pollution, then please embrace smart-doc it!
Features
- Notes zero, zero learning costs, ease of integration, just a standard java to write a comment.
- (Based on source code interface definition automatically derived from a unique implementation stage to derive an infinite object association ).
- 支持Spring MVC,Spring Boot。
- Part fastjson currently defined on the javabean support jackson and notes.
- Support jsr303 parametric test to determine whether the parameters based on javabean necessary.
- Interface json request parameters can be automatically generated json simulation parameters.
- Some commonly defined fields can be generated valid analog.
- Generating a return value json exemplary support.
- Support from the project to build a field annotation external load source code.
- A detection tool code comments, do not write comments small partner can not escape the discernment.
update content
- Upgrade smart-doc dependent foundation libraries.
- Increase the production of assembled exemplary Common parameters get requests.
-
Increased spring mvc placeholder restful url sample request generated.
Upgrade Recommendation
Currently the software features continue iteration, smart-doc original user is strongly recommended to upgrade to the latest version.
The next version upgrade notice
At present, some important features smart-doc development has been completed, the Festival will release the next major version. The next upgrade will mean that it will provide services to more developers,
As many java web developer will be the first choice of the true meaning of api doc generation tool, also means not much time left to swagger, need small collection of good partner, please hurry. The next edition features trailer (has entered the testing phase):
- New Spring Boot Web Flux (controller notation).
- Add to derive support asynchronous interfaces returned Callable, Future, CompletableFuture and so on.
- Last modified versions of smart-doc generated document some of the details.
- Key : New generation of static html bookmarked documents for online viewing api api documentation (can preview smart-doc in providing demo html file)
DEMO
Use demo Easy Fun Interface document generation
Related Documents
Rediscover about java web restful api documentation
smart-doc feature uses Introduction