项目作者: AtulRanjan

项目描述 :
A complete demo project for a Restful API with proper automated API documentation
高级语言: HTML
项目地址: git://github.com/AtulRanjan/spring-boot2-example.git
创建时间: 2017-09-15T13:32:39Z
项目社区:https://github.com/AtulRanjan/spring-boot2-example

开源协议:

下载


Restful API with proper automated API documentation

Build Project

To build the project, Run following command
  1. mvn clean install

Running the Project

To run the project, Run following command
  1. mvn spring-boot:run
Testing the API using swagger

Click on the link to access the swagger ui.

Swagger-UI http://localhost:7772/spring-boot2/swagger-ui.html

Creating static API Documentation

To create static document in pdf and html format, Run following command

  1. mvn test

Three files will be created in \src\main\resources\asciidoc directory

  1. api-doc.adoc

  2. api-doc.html

  3. api-doc.pdf