您好,登錄后才能下訂單哦!
本篇文章為大家展示了SpringBoot2中怎么利用Swagger2構(gòu)建接口管理界面,內(nèi)容簡明扼要并且容易理解,絕對能使你眼前一亮,通過這篇文章的詳細(xì)介紹希望你能有所收獲。
整合到Spring Boot中,構(gòu)建強(qiáng)大RESTful API文檔。省去接口文檔管理工作,修改代碼,自動更新,Swagger2也提供了強(qiáng)大的頁面測試功能來調(diào)試RESTful API。
Api:修飾整個類,描述Controller的作用 ApiOperation:描述一個類的一個方法,或者說一個接口 ApiParam:單個參數(shù)描述 ApiModel:用對象來接收參數(shù) ApiProperty:用對象接收參數(shù)時,描述對象的一個字段 ApiResponse:HTTP響應(yīng)其中1個描述 ApiResponses:HTTP響應(yīng)整體描述 ApiIgnore:使用該注解忽略這個API ApiError :發(fā)生錯誤返回的信息 ApiImplicitParam:一個請求參數(shù) ApiImplicitParams:多個請求參數(shù)
spring-boot:2.1.3.RELEASE swagger:2.6.1
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; /** * Swagger 配置文件 */ @Configuration public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.swagger.two")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("SpringBoot利用Swagger構(gòu)建API文檔") .description("使用RestFul風(fēng)格, 創(chuàng)建人:知了一笑") .termsOfServiceUrl("https://github.com/cicadasmile") .version("version 1.0") .build(); } }
@EnableSwagger2 @SpringBootApplication public class SwaggerApplication { public static void main(String[] args) { SpringApplication.run(SwaggerApplication.class,args) ; } }
(1)、代碼塊
@ApiOperation(value="添加用戶", notes="創(chuàng)建新用戶") @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實體user", required = true, dataType = "User") @RequestMapping(value = "/addUser", method = RequestMethod.POST) public ResponseEntity<JsonResult> addUser (@RequestBody User user){ JsonResult result = new JsonResult(); try { users.put(user.getId(), user); result.setResult(user.getId()); result.setStatus("ok"); } catch (Exception e) { result.setResult("服務(wù)異常"); result.setStatus("500"); e.printStackTrace(); } return ResponseEntity.ok(result); }
(2)、效果圖
(1)、代碼塊
@ApiOperation(value="用戶列表", notes="查詢用戶列表") @RequestMapping(value = "/getUserList", method = RequestMethod.GET) public ResponseEntity<JsonResult> getUserList (){ JsonResult result = new JsonResult(); try { List<User> userList = new ArrayList<>(users.values()); result.setResult(userList); result.setStatus("200"); } catch (Exception e) { result.setResult("服務(wù)異常"); result.setStatus("500"); e.printStackTrace(); } return ResponseEntity.ok(result); }
(2)、效果圖
(1)、代碼塊
@ApiOperation(value="用戶查詢", notes="根據(jù)ID查詢用戶") @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Integer", paramType = "path") @RequestMapping(value = "/getUserById/{id}", method = RequestMethod.GET) public ResponseEntity<JsonResult> getUserById (@PathVariable(value = "id") Integer id){ JsonResult result = new JsonResult(); try { User user = users.get(id); result.setResult(user); result.setStatus("200"); } catch (Exception e) { result.setResult("服務(wù)異常"); result.setStatus("500"); e.printStackTrace(); } return ResponseEntity.ok(result); }
(2)、效果圖
(1)、代碼塊
@ApiOperation(value="更新用戶", notes="根據(jù)Id更新用戶信息") @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long",paramType = "path"), @ApiImplicitParam(name = "user", value = "用戶對象user", required = true, dataType = "User") }) @RequestMapping(value = "/updateById/{id}", method = RequestMethod.PUT) public ResponseEntity<JsonResult> updateById (@PathVariable("id") Integer id, @RequestBody User user){ JsonResult result = new JsonResult(); try { User user1 = users.get(id); user1.setUsername(user.getUsername()); user1.setAge(user.getAge()); users.put(id, user1); result.setResult(user1); result.setStatus("ok"); } catch (Exception e) { result.setResult("服務(wù)異常"); result.setStatus("500"); e.printStackTrace(); } return ResponseEntity.ok(result); }
(2)、效果圖
(1)、代碼塊
@ApiOperation(value="刪除用戶", notes="根據(jù)id刪除指定用戶") @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long", paramType = "path") @RequestMapping(value = "/deleteById/{id}", method = RequestMethod.DELETE) public ResponseEntity<JsonResult> deleteById (@PathVariable(value = "id") Integer id){ JsonResult result = new JsonResult(); try { users.remove(id); result.setResult(id); result.setStatus("ok"); } catch (Exception e) { result.setResult("服務(wù)異常"); result.setStatus("500"); e.printStackTrace(); } return ResponseEntity.ok(result); }
(2)、效果圖
上述內(nèi)容就是SpringBoot2中怎么利用Swagger2構(gòu)建接口管理界面,你們學(xué)到知識或技能了嗎?如果還想學(xué)到更多技能或者豐富自己的知識儲備,歡迎關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。