{"id":71556,"date":"2024-07-31T02:59:54","date_gmt":"2024-07-30T23:29:54","guid":{"rendered":"https:\/\/nabfollower.com\/blog\/documentando-uma-api-com-java-spring-boot-usando-swagger-4hgd\/"},"modified":"2024-07-31T02:59:54","modified_gmt":"2024-07-30T23:29:54","slug":"documentando-uma-api-com-java-spring-boot-usando-swagger-4hgd","status":"publish","type":"post","link":"https:\/\/nabfollower.com\/blog\/documentando-uma-api-com-java-spring-boot-usando-swagger-4hgd\/","title":{"rendered":"\u0645\u0633\u062a\u0646\u062f\u0633\u0627\u0632\u06cc \u06cc\u06a9 API \u0628\u0627 Java Spring Boot \u0628\u0627 \u0627\u0633\u062a\u0641\u0627\u062f\u0647 \u0627\u0632 Swagger"},"content":{"rendered":"
\n

\u0645\u0631\u0627\u062d\u0644 \u0645\u0633\u062a\u0646\u062f\u0633\u0627\u0632\u06cc API RESTful \u062f\u0631 Java Spring Boot \u0628\u0627 Swagger<\/p>\n

    \n
  1. \u0648\u0627\u0628\u0633\u062a\u06af\u06cc \u0647\u0627\u06cc Swagger \u0631\u0627 \u0627\u0636\u0627\u0641\u0647 \u06a9\u0646\u06cc\u062f<\/strong><\/li>\n<\/ol>\n

    \u0648\u0627\u0628\u0633\u062a\u06af\u06cc \u0647\u0627\u06cc Swagger \u0631\u0627 \u062f\u0631 \u0641\u0627\u06cc\u0644 pom.xml \u0627\u0636\u0627\u0641\u0647 \u06a9\u0646\u06cc\u062f:<\/p>\n

    \n
    <\/span>\n    <\/span>io.springfox\n    <\/span>springfox-swagger2\n    <\/span>2.9.2\n\n<\/span>\n    <\/span>io.springfox\n    <\/span>springfox-swagger-ui\n    <\/span>2.9.2\n\n<\/code><\/pre>\n
    \n
    \n    \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n
        \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n<\/div>\n<\/div>\n<\/div>\n
      \n
    1. Swagger \u0631\u0627 \u067e\u06cc\u06a9\u0631\u0628\u0646\u062f\u06cc \u06a9\u0646\u06cc\u062f<\/strong><\/li>\n<\/ol>\n
      \u06cc\u06a9 \u06a9\u0644\u0627\u0633 \u067e\u06cc\u06a9\u0631\u0628\u0646\u062f\u06cc Swagger \u0627\u06cc\u062c\u0627\u062f \u06a9\u0646\u06cc\u062f:<\/p>\n
      \n
      import<\/span> org.springframework.context.annotation.Bean<\/span>;<\/span>\nimport<\/span> org.springframework.context.annotation.Configuration<\/span>;<\/span>\nimport<\/span> springfox.documentation.builders.ApiInfoBuilder<\/span>;<\/span>\nimport<\/span> springfox.documentation.builders.PathSelectors<\/span>;<\/span>\nimport<\/span> springfox.documentation.builders.RequestHandlerSelectors<\/span>;<\/span>\nimport<\/span> springfox.documentation.spi.DocumentationType<\/span>;<\/span>\nimport<\/span> springfox.documentation.spring.web.plugins.Docket<\/span>;<\/span>\nimport<\/span> springfox.documentation.swagger2.annotations.EnableSwagger2<\/span>;<\/span>\n\n@Configuration<\/span>\n@EnableSwagger2<\/span>\npublic<\/span> class<\/span> SwaggerConfig<\/span> {<\/span>\n    @Bean<\/span>\n    public<\/span> Docket<\/span> api<\/span>()<\/span> {<\/span>\n        return<\/span> new<\/span> Docket<\/span>(<\/span>DocumentationType<\/span>.<\/span>SWAGGER_2<\/span>)<\/span>\n                .<\/span>select<\/span>()<\/span>\n                .<\/span>apis<\/span>(<\/span>RequestHandlerSelectors<\/span>.<\/span>basePackage<\/span>(<\/span>\"com.example\"<\/span>))<\/span>\n                .<\/span>paths<\/span>(<\/span>PathSelectors<\/span>.<\/span>any<\/span>())<\/span>\n                .<\/span>build<\/span>()<\/span>\n                .<\/span>apiInfo<\/span>(<\/span>new<\/span> ApiInfoBuilder<\/span>()<\/span>\n                        .<\/span>title<\/span>(<\/span>\"My API\"<\/span>)<\/span>\n                        .<\/span>description<\/span>(<\/span>\"This is a RESTful API in Java Spring Boot using Swagger\"<\/span>)<\/span>\n                        .<\/span>version<\/span>(<\/span>\"1.0\"<\/span>)<\/span>\n                        .<\/span>contact<\/span>(<\/span>new<\/span> springfox<\/span>.<\/span>documentation<\/span>.<\/span>service<\/span>.<\/span>Contact<\/span>(<\/span>\"API Support\"<\/span>,<\/span> \"\"<\/span>,<\/span> \"support@example.com\"<\/span>))<\/span>\n                        .<\/span>build<\/span>());<\/span>\n    }<\/span>\n}<\/span>\n<\/code><\/pre>\n
      \n
      \n    \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n
          \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n<\/div>\n<\/div>\n<\/div>\n
        \n
      1. \u062d\u0627\u0634\u06cc\u0647 \u0646\u0648\u06cc\u0633\u06cc Swagger \u0631\u0627 \u0628\u0631\u0627\u06cc \u062a\u0648\u0635\u06cc\u0641 \u0646\u0642\u0627\u0637 \u067e\u0627\u06cc\u0627\u0646\u06cc\u060c \u067e\u0627\u0631\u0627\u0645\u062a\u0631\u0647\u0627 \u0648 \u067e\u0627\u0633\u062e \u0647\u0627 \u0627\u0636\u0627\u0641\u0647 \u06a9\u0646\u06cc\u062f<\/strong><\/li>\n<\/ol>\n
        \u0646\u06a9\u0627\u062a \u0639\u0645\u0644\u06cc\u0627\u062a\u06cc:<\/p>\n
        \u0628\u0631\u0627\u06cc \u0647\u0631 \u0646\u0642\u0637\u0647 \u067e\u0627\u06cc\u0627\u0646\u06cc\u060c \u06cc\u0627\u062f\u062f\u0627\u0634\u062a \u0647\u0627\u06cc\u06cc \u0628\u0627 \u062c\u0632\u0626\u06cc\u0627\u062a \u062f\u0631\u062e\u0648\u0627\u0633\u062a HTTP\u060c \u0645\u0633\u06cc\u0631 \u0648 \u06cc\u06a9 \u062e\u0644\u0627\u0635\u0647 \u0627\u0648\u0644\u06cc\u0647 \u0627\u0636\u0627\u0641\u0647 \u06a9\u0646\u06cc\u062f.<\/p>\n
        \n
        import<\/span> io.swagger.annotations.Api<\/span>;<\/span>\nimport<\/span> io.swagger.annotations.ApiOperation<\/span>;<\/span>\nimport<\/span> io.swagger.annotations.ApiParam<\/span>;<\/span>\nimport<\/span> org.springframework.web.bind.annotation.GetMapping<\/span>;<\/span>\nimport<\/span> org.springframework.web.bind.annotation.PathVariable<\/span>;<\/span>\nimport<\/span> org.springframework.web.bind.annotation.RequestMapping<\/span>;<\/span>\nimport<\/span> org.springframework.web.bind.annotation.RestController<\/span>;<\/span>\n\nimport<\/span> java.util.List<\/span>;<\/span>\n\n@RestController<\/span>\n@RequestMapping<\/span>(<\/span>\"\/movies\"<\/span>)<\/span>\n@Api<\/span>(<\/span>tags<\/span> =<\/span> \"Movies\"<\/span>)<\/span>\npublic<\/span> class<\/span> MovieController<\/span> {<\/span>\n\n    @ApiOperation<\/span>(<\/span>value<\/span> =<\/span> \"Get a list of movies\"<\/span>,<\/span> notes<\/span> =<\/span> \"Retrieves a list of movies\"<\/span>)<\/span>\n    @GetMapping<\/span>\n    public<\/span> List<\/span>Movie<\/span>><\/span> getMovies<\/span>()<\/span> {<\/span>\n        \/\/ code ...<\/span>\n    }<\/span>\n\n    @ApiOperation<\/span>(<\/span>value<\/span> =<\/span> \"Get a movie by ID\"<\/span>,<\/span> notes<\/span> =<\/span> \"Retrieves a movie by its ID\"<\/span>)<\/span>\n    @GetMapping<\/span>(<\/span>\"\/{id}\"<\/span>)<\/span>\n    public<\/span> Movie<\/span> getMovie<\/span>(<\/span>\n            @ApiParam<\/span>(<\/span>value<\/span> =<\/span> \"ID of the movie to be obtained\"<\/span>,<\/span> required<\/span> =<\/span> true<\/span>)<\/span> \n            @PathVariable<\/span> String<\/span> id<\/span>)<\/span> {<\/span>\n        \/\/ code ...<\/span>\n    }<\/span>\n}<\/span>\n<\/span><\/code><\/pre>\n
        \n
        \n    \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n
            \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n<\/div>\n<\/div>\n<\/div>\n
        \u062a\u0639\u0631\u06cc\u0641 \u0627\u0644\u06af\u0648\u0647\u0627\u06cc \u067e\u0627\u0633\u062e:<\/p>\n
        \n
        import<\/span> io.swagger.annotations.ApiModel<\/span>;<\/span>\nimport<\/span> io.swagger.annotations.ApiModelProperty<\/span>;<\/span>\n\n@ApiModel<\/span>(<\/span>description<\/span> =<\/span> \"Details about the Movie\"<\/span>)<\/span>\npublic<\/span> class<\/span> Movie<\/span> {<\/span>\n\n    @ApiModelProperty<\/span>(<\/span>notes<\/span> =<\/span> \"The unique ID of the movie\"<\/span>)<\/span>\n    private<\/span> String<\/span> id<\/span>;<\/span>\n\n    @ApiModelProperty<\/span>(<\/span>notes<\/span> =<\/span> \"The name of the movie\"<\/span>)<\/span>\n    private<\/span> String<\/span> name<\/span>;<\/span>\n\n    \/\/ getters and setters<\/span>\n}<\/span>\n\n@ApiModel<\/span>(<\/span>description<\/span> =<\/span> \"Details about the ErrorResponse\"<\/span>)<\/span>\npublic<\/span> class<\/span> ErrorResponse<\/span> {<\/span>\n\n    @ApiModelProperty<\/span>(<\/span>notes<\/span> =<\/span> \"The error code\"<\/span>)<\/span>\n    private<\/span> int<\/span> code<\/span>;<\/span>\n\n    @ApiModelProperty<\/span>(<\/span>notes<\/span> =<\/span> \"The error message\"<\/span>)<\/span>\n    private<\/span> String<\/span> message<\/span>;<\/span>\n\n    \/\/ getters and setters<\/span>\n}<\/span>\n<\/code><\/pre>\n
        \n
        \n    \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n
            \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n<\/div>\n<\/div>\n<\/div>\n
          \n
        1. \u0627\u06cc\u062c\u0627\u062f \u0645\u0633\u062a\u0646\u062f\u0627\u062a Swagger<\/strong><\/li>\n<\/ol>\n
          \u0628\u0631\u0646\u0627\u0645\u0647 Spring Boot \u0631\u0627 \u0631\u0627\u0647 \u0627\u0646\u062f\u0627\u0632\u06cc \u06a9\u0646\u06cc\u062f \u0648 \u0628\u0647 \u0631\u0627\u0628\u0637 \u06a9\u0627\u0631\u0628\u0631\u06cc Swagger UI \u062f\u0631 \u0645\u0631\u0648\u0631\u06af\u0631 \u062f\u0633\u062a\u0631\u0633\u06cc \u067e\u06cc\u062f\u0627 \u06a9\u0646\u06cc\u062f:<\/p>\n
          \n
          http:\/\/localhost:8080\/swagger-ui.html\n<\/code><\/pre>\n
          \n
          \n    \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n
              \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n<\/div>\n<\/div>\n<\/div>\n
            \n
          1. \u0634\u06cc\u0648\u0647 \u0647\u0627\u06cc \u0645\u0633\u062a\u0646\u062f\u0633\u0627\u0632\u06cc \u062e\u0648\u0628<\/strong><\/li>\n<\/ol>\n
              \n
            • \u0627\u0632 \u0632\u0628\u0627\u0646 \u062a\u0648\u0635\u06cc\u0641\u06cc \u0648 \u0645\u062e\u062a\u0635\u0631 \u0628\u0631\u0627\u06cc \u06a9\u0645\u06a9 \u0628\u0647 \u062f\u0631\u06a9 API \u0627\u0633\u062a\u0641\u0627\u062f\u0647 \u06a9\u0646\u06cc\u062f.<\/li>\n
            • \u062a\u0631\u062a\u06cc\u0628 \u06cc\u0627\u062f\u062f\u0627\u0634\u062a \u0647\u0627 \u0631\u0627 \u0628\u0647 \u0637\u0648\u0631 \u0645\u0646\u0637\u0642\u06cc \u0633\u0627\u0632\u0645\u0627\u0646\u062f\u0647\u06cc \u06a9\u0646\u06cc\u062f \u062a\u0627 \u0627\u0632 \u06cc\u06a9 \u062c\u0631\u06cc\u0627\u0646 \u0648\u0627\u0636\u062d \u0648 \u0627\u0633\u062a\u0627\u0646\u062f\u0627\u0631\u062f \u067e\u06cc\u0631\u0648\u06cc \u06a9\u0646\u06cc\u062f \u0648 \u0646\u06af\u0647\u062f\u0627\u0631\u06cc \u0631\u0627 \u0622\u0633\u0627\u0646 \u062a\u0631 \u06a9\u0646\u06cc\u062f.<\/li>\n
            • \u0627\u0633\u0646\u0627\u062f \u0631\u0627 \u0647\u0631 \u0632\u0645\u0627\u0646 \u06a9\u0647 \u062a\u063a\u06cc\u06cc\u0631\u0627\u062a\u06cc \u062f\u0631 API \u0627\u06cc\u062c\u0627\u062f \u0645\u06cc \u0634\u0648\u062f \u0628\u0647 \u0631\u0648\u0632 \u06a9\u0646\u06cc\u062f \u062a\u0627 \u0622\u0646 \u0631\u0627 \u062b\u0627\u0628\u062a \u0648 \u0645\u0641\u06cc\u062f \u0646\u06af\u0647 \u062f\u0627\u0631\u06cc\u062f.<\/li>\n<\/ul>\n
              \u0628\u0627 \u062f\u0646\u0628\u0627\u0644 \u06a9\u0631\u062f\u0646 \u0627\u06cc\u0646 \u0645\u0631\u0627\u062d\u0644\u060c \u0645\u06cc \u062a\u0648\u0627\u0646\u06cc\u062f API \u062e\u0648\u062f \u0631\u0627 \u062f\u0631 Java Spring Boot \u0628\u0627 \u0627\u0633\u062a\u0641\u0627\u062f\u0647 \u0627\u0632 Swagger \u0628\u0647 \u0637\u0648\u0631 \u0645\u0648\u062b\u0631 \u0648 \u0648\u0627\u0636\u062d \u0645\u0633\u062a\u0646\u062f \u06a9\u0646\u06cc\u062f.<\/p>\n<\/p><\/div>\n","protected":false},"excerpt":{"rendered":"
              \u0645\u0631\u0627\u062d\u0644 \u0645\u0633\u062a\u0646\u062f\u0633\u0627\u0632\u06cc API RESTful \u062f\u0631 Java Spring Boot \u0628\u0627 Swagger \u0648\u0627\u0628\u0633\u062a\u06af\u06cc \u0647\u0627\u06cc Swagger \u0631\u0627 \u0627\u0636\u0627\u0641\u0647 \u06a9\u0646\u06cc\u062f \u0648\u0627\u0628\u0633\u062a\u06af\u06cc \u0647\u0627\u06cc Swagger \u0631\u0627 \u062f\u0631 \u0641\u0627\u06cc\u0644 pom.xml \u0627\u0636\u0627\u0641\u0647 \u06a9\u0646\u06cc\u062f: io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f Swagger \u0631\u0627 \u067e\u06cc\u06a9\u0631\u0628\u0646\u062f\u06cc \u06a9\u0646\u06cc\u062f \u06cc\u06a9 \u06a9\u0644\u0627\u0633 \u067e\u06cc\u06a9\u0631\u0628\u0646\u062f\u06cc Swagger \u0627\u06cc\u062c\u0627\u062f \u06a9\u0646\u06cc\u062f: import org.springframework.context.annotation.Bean; import …<\/p>\n","protected":false},"author":2,"featured_media":71557,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"fifu_image_url":"","fifu_image_alt":"","footnotes":""},"categories":[339],"tags":[],"class_list":["post-71556","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-dev"],"_links":{"self":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/posts\/71556","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/comments?post=71556"}],"version-history":[{"count":0,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/posts\/71556\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/media\/71557"}],"wp:attachment":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/media?parent=71556"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/categories?post=71556"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/tags?post=71556"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}