Spring Boot 與 swagger 結合

. 配置pom.xml

2. 更改端口號,

在src/main/resources 下面添加一個application.yml文件.

3. 添加一個ModelCase entity.

4. 添加一個interface.

說明:

@Api: 做用在class上,對class的說明.

@ApiOperation: 做用在method上,對method的說明.

@ApiResponses: 表示響應.

@ApiResponse: 在ApiResponses中,表示一組響應.

@RequestMapping: 表示rest api 地址及方法

@ApiParam: 對參數進行說明

@Valid: 表示啓用驗證功能,可是你的entity必須包含相關注解,好比NotNull/Min等.

@RequestBody: 爲了映射到entity從 request body中.

 

5. 添加實現

 

6. 添加一個Swagger 配置class

說明:

裏面包含了一些描述及版本信息.

 

到這裏就所有完成,如今能夠去瀏覽器訪問 http://localhost:8081/swagger-ui.html

可以看到以下: 包含了2個controller 以及上面的一些描述