SpringBoot中如何使用Swagger

這篇文章將為大家詳細講解有關SpringBoot中如何使用Swagger，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。

項目結構

1. 配置文件

   @Configuration
   @EnableSwagger2
   public class Swagger2Config {
       //swagger2的配置文件，可以配置swagger2的一些基本的內容，比如掃描的包等等
       @Bean
       public Docket defaultApi(){
           return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("默認分組").select()
                   .apis(RequestHandlerSelectors.basePackage("com.chenwenhuan.springbootlearning.controller"))
                   .paths(PathSelectors.any()).build();
       }
   
       // 預覽地址:http://localhost:8082/swagger-ui.html#/
       private ApiInfo apiInfo() {
           return new ApiInfoBuilder()
                   .title("整合swagger構建測試系統api文檔")
                   .description("接口訪問地址：http://localhost:8082/")
                   .termsOfServiceUrl("http://localhost:8082/")
                   .version("1.0")
                   .build();
       }
   }

   
   

    

2. pom.xml 新增依賴

           <dependency>
               <groupId>io.springfox</groupId>
               <artifactId>springfox-swagger2</artifactId>
               <version>2.7.0</version>
           </dependency>
           <dependency>
               <groupId>io.springfox</groupId>
               <artifactId>springfox-swagger-ui</artifactId>
               <version>2.7.0</version>
           </dependency>

   
   

    

3. Controller注解

   @Api(value="用戶api", tags="用戶api")
   @RestController
   @RequestMapping("/user")
   public class UserController {
   
       @Autowired
       UserService userService;
   
       @GetMapping("/findAll")
       public List<User> findAll(){
           return userService.findAll();
       }
   
       @ApiOperation(value="獲取用戶信息", notes="根據url的id來獲取信息")
       @ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用戶ID", paramType = "query",required = true)})
       @GetMapping("/getUser")
       public User getUser(@RequestParam int id){
           return userService.getUserById(id);
       }
   
       @PostMapping("/creatUser")
       public void creatUser(User user){
           System.out.println(user);
           userService.insert(user);
       }
   
       @PostMapping("/creatUserList")
       public void creatUserList(@RequestBody List<User> list){
           userService.insertList(list);
       }
   }

   
   

    

4. 啟動項目訪問預覽地址  http://localhost:8082/swagger-ui.html#/，效果如下。（可以看出此處很多信息都源自配置Swagger2Config）

5. 示例1

輸入參數點擊Try it out!，可以查看返回碼和返回數據

• 示例2：

參考右邊提示，按格式輸入Json格式的對象數組

• 示例3：

controller需要注解 paramType = "query"，否則需要按Example Value 格式輸入。required：是否必輸

@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用戶ID", paramType = "query",required = true)})

關于SpringBoot中如何使用Swagger就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。