Quarkus集成open api接口使用swagger ui展示

< dependency >

             < groupId >io.quarkus</ groupId >

             < artifactId >quarkus-smallrye-openapi</ artifactId >

</ dependency >

/**

  * @author kl : http://kailing.pub

  * @version 1.0

  * @date 2020/7/14 11:29

  */

@OpenAPIDefinition (

         info = @Info (

                 title = "用户信息系统接口" ,

                 version = "1.0.1" ,

                 description = "这个信息是用来描述swagger ui接口的，你可以根据这个信息来了解这个系统的api情况" ,

                 contact = @Contact (

                         name = "kl博主" ,

                         url = "http://HdhCmsTestkailing.pub" ,

                         email = "632104866@qq测试数据" )

         )

)

public class SwaggerConfig extends Application {

}

/**

  * @author kl : http://kailing.pub

  * @version 1.0

  * @date 2020/7/14 11:05

  */

@Path ( "/user" )

@Produces (MediaType.APPLICATION_JSON)

@Consumes (MediaType.APPLICATION_JSON)

@Tag (name = "UserResource" ,description = "用户接口列表" )

public class UserResource {

     @POST

     @Path ( "/add" )

     @Operation (summary = "创建用户" , description = "这是一个创建用户的接口" )

     public String createUser(UserDto userDto) {

         return "hello" ;

     }

     @POST

     @Path ( "/update" )

     @Operation (summary = "更新用户" , description = "这是更新用户的接口" )

     public UserDto update( @RequestBody (description = "更新用户实体" , required = true ,

             content = @Content (schema = @Schema (implementation = UserDto. class ))) UserDto userDto) {

         return userDto;

     }

     @GET

     @Path ( "/{userId}" )

     @Operation (summary = "查找用户" , description = "这是查找用户的接口" )

     @APIResponse (responseCode = "400" , description = "找不到这个用户" )

     public UserDto findUser( @Parameter (description = "用户的ID" , required = true ) @PathParam ( "userId" ) Integer userId){

         return new UserDto();

     }

     /**

      * 使用 @Operation(hidden = true) 隐藏这个api，不在swagger ui中展示

      */

     @GET

     @Path ( "/hello" )

     @Operation (hidden = true )

     public String hello(){

         return "hello" ;

     }

}

/**

  * @author kl : http://kailing.pub

  * @version 1.0

  * @date 2020/7/14 11:12

  */

@Schema ( description = "这是一个用户的传输实体" )

public class UserDto {

     //隐藏内部使用的属性

     @Schema (hidden = true )

     private Integer id;

     @Schema (title = "姓名" , required = true , example = "kl" )

     private String name;

     @Schema (title = "年龄" , required = true , maximum = "120" ,minimum = "1" ,example = "19" , type = SchemaType.INTEGER)

     private Integer age;

}