Springfoxを使用したSwagger UIのタイトルと説明の変更

Question

私はSpringBootアプリケーションを構築し、SpringFlow Swagger UIを使用してSwagger UIを使用してそれを文書化しています。私はすべてのことを文書化していますが、タイトルと説明をカスタマイズしたいのですが、どのように考え出すことはできません。たとえば、この画像のhttps://springfox.github.io/springfox/docs/current/images/springfox-swagger-ui.pngは「Springfox petstore API」で、説明はLorem Ipsumです。しかし、SwaggerのUIでは、タイトルと説明の両方が「APIドキュメント」と言います。 @SwaggerDefinitionアノテーションを使ってみましたが、何もしないようです。

Answer 1

swagger editorを使用することをお勧めします。次に、トップメニューから "Generate Server"オプションを使用して、APIドキュメントからSpringブートサーバーを自動生成できます。初めてAPIを生成するのは本当に素晴らしいことです。

あなたはYAMLから設定したい場合は、情報セクションでは、このフィールドを提供する必要があります。闊歩エディタから生成されたクラスをチェックして、あなたのコードと比較し、コードから

info: 
    version: "1.0.0" 
    title: My API title 
    description: "Awesome description" 

。説明とタイトルを設定し、SwaggerDocumentationConfigクラスの内部にあるApiInfo Builderオブジェクトに対応する属性を設定することができます。ここで

あなたは、コードを持っている：

@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2017-10-05T14:03:51.916-03:00") 

@EnableSwagger2 
@Configuration 
public class SwaggerDocumentationConfig { 

    ApiInfo apiInfo() { 
     return new ApiInfoBuilder() 
      .title("My API Title") 
      .description("Awesome description") 
      .license("Apache 2.0") 
      .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") 
      .termsOfServiceUrl("") 
      .version("1.0.0") 
      .contact(new Contact("", "", "contact@contact.com.uy")) 
      .build(); 
    } 

    @Bean 
    public Docket customImplementation() { 
     return new Docket(DocumentationType.SWAGGER_2) 
      .select() 
      .apis(RequestHandlerSelectors.basePackage("com.mypackage.api")) 
      .build() 
      .apiInfo(apiInfo()); 
    } 
} 

これのどれもあなたに理にかなっていない場合、あなたはSpringfoxを使用していて、私はより良いあなたを助けることができる方法を知っている私にあなたのコードのもう少しを示しています。

ベストアンサーに！