摘要:版本開啟注解配置啟動后訪問參考之使用展示的
swagger版本
com.mangofactory
com.mangofactory swagger-springmvc 1.0.2
io.springfox
開啟swagger22.2.2 io.springfox springfox-swagger-ui ${springfox.version} io.springfox springfox-swagger2 ${springfox.version}
/** * Created by codecraft on 2016-05-05. */ @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket swaggerSpringMvcPlugin() { return new Docket(DocumentationType.SWAGGER_2) .select().paths(paths()).build().apiInfo(apiInfo()); } @SuppressWarnings("unchecked") private Predicatedomain注解paths() { return Predicates.or(Predicates.containsPattern("/api/*")); } private ApiInfo apiInfo() { String title = "my api"; String description = "api desc"; String version = "1.0.0-snapshot"; String contact = "codecraft@gmail.com"; ApiInfo apiInfo = new ApiInfo(title,description,version, "terms of service", contact, "", ""); return apiInfo; } }
package com.codecraft.domain; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; /** * Created by codecraft on 2016-05-05. */ @ApiModel public class User { @ApiModelProperty(value = "User ID") private String id; @ApiModelProperty(value = "first name") private String firstName; @ApiModelProperty(value = "last name") private String lastName; public User() { } public User(String id, String firstName, String lastName) { this.id = id; this.firstName = firstName; this.lastName = lastName; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } public String getFirstName() { return firstName; } public void setFirstName(String firstName) { this.firstName = firstName; } }controller配置
@RestController @RequestMapping("/api/user") public class UserController { private ConcurrentHashMapuserMap = new ConcurrentHashMap<>(); @RequestMapping(method = RequestMethod.POST) public String add(@RequestBody @ApiParam(name = "user",value = "json format",required = true) User user){ userMap.put(user.getId(),user); return "add successfully"; } @RequestMapping(method = RequestMethod.PUT) public String update(@RequestBody @ApiParam(name = "user",value = "json format",required = true) User user) { userMap.put(user.getId(),user); return "update successfully"; } @RequestMapping(method = RequestMethod.GET) public User get(@RequestParam(value = "id", required = true) String id){ return userMap.get(id); } @RequestMapping(method = RequestMethod.DELETE) public String delete(@RequestParam(value = "id", required = true) String id){ userMap.remove(id); return "delete successfully"; } }
啟動后訪問
http://localhost:8080/swagger-ui.html
spring boot之使用springfox swagger展示restful的api doc
文章版權歸作者所有,未經(jīng)允許請勿轉載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/65876.html
摘要:今天給你們帶來集成的教程。接口返回結果不明確。這些痛點在前后端分離的大型項目上顯得尤為煩躁。接口返回結果非常明確,包括數(shù)據(jù)類型,狀態(tài)碼,錯誤信息等。生成后的文件依賴如下這里使用的是的版本。另外,關注之后在發(fā)送可領取免費學習資料。 微信公眾號:一個優(yōu)秀的廢人如有問題或建議,請后臺留言,我會盡力解決你的問題。 前言 快過年了,不知道你們啥時候放年假,忙不忙。反正我是挺閑的,所以有時間寫 b...
摘要:前后端分離后,維護接口文檔基本上是必不可少的工作。一個理想的狀態(tài)是設計好后,接口文檔發(fā)給前端和后端,大伙按照既定的規(guī)則各自開發(fā),開發(fā)好了對接上了就可以上線了。本文主要和大伙來聊下在中如何整合。如此,就算配置成功了,非常方便。 前后端分離后,維護接口文檔基本上是必不可少的工作。一個理想的狀態(tài)是設計好后,接口文檔發(fā)給前端和后端,大伙按照既定的規(guī)則各自開發(fā),開發(fā)好了對接上了就可以上線了。當然...
摘要:新手上路搭建項目是一個接口文檔軟件界面如下添加這里使用版本可以正常使用配置文件測試新手上路。 新手上路-搭建項目-springboot-swagger2 swagger2 是一個接口文檔軟件 界面如下 showImg(https://segmentfault.com/img/bVOoim); gradle添加 compile(io.springfox:springfox-swagger...
閱讀 4221·2021-09-26 10:17
閱讀 871·2021-09-22 15:02
閱讀 3446·2021-09-06 15:00
閱讀 1055·2021-07-25 16:52
閱讀 2734·2019-08-29 16:16
閱讀 2515·2019-08-29 13:25
閱讀 1588·2019-08-26 13:51
閱讀 2182·2019-08-26 10:58