web-dev-qa-db-ja.com

swagger.jsonを生成する方法

私はプロジェクト用にJavaスプリングブートフレームワークを使用してREST apiを作成し、「springfox-swagger2およびspringfox-swagger-ui」を使用してswaggerドキュメントを生成しています。 url http：// localhost：8080/swagger-ui.html を使用してドキュメントを表示できます。

swagger.json/spec.jsonを作成または生成するにはどうすればよいですか？このアプリケーションではドキュメントを作成しないでください。APIをリストするために別のアプリケーションを使用しています。 docs

spring-mvcswaggerswagger-uiswagger-2.0
25
Bikesh M

私は小さなトリックでこれをやった

ホームコントローラーのテストケースの最後に次のコードを追加しました

import org.springframework.boot.test.web.client.TestRestTemplate;

public class HomeControllerTest extends .... ...... {

@Autowired
private TestRestTemplate restTemplate;


@Test
public void testHome() throws Exception {
     //.......
     //... my home controller test code 
     //.....

    String swagger = this.restTemplate.getForObject("/v2/api-docs", String.class);

    this.writeFile("spec.json", swagger );
}

public void writeFile(String fileName, String content) {

    File theDir = new File("swagger");

    if (!theDir.exists()) {
        try{
            theDir.mkdir();
        } 
        catch(SecurityException se){ }        
    }

    BufferedWriter bw = null;
    FileWriter fw = null;
    try {
        fw = new FileWriter("swagger/"+fileName);
        bw = new BufferedWriter(fw);
        bw.write(content);
    } catch (IOException e) {
        e.printStackTrace();
    } finally {
        try {
            if (bw != null)
                bw.close();
            if (fw != null)
                fw.close();
        } catch (IOException ex) {
            ex.printStackTrace();
        }

    }

}
}

これが正しい方法であるかどうかはわかりませんが、動作しています:)

依存

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.4.0</version>
    </dependency>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>
8
Bikesh M

Swagger-ui htmlページでURLを取得できます。

enter image description here

GET http://localhost:8080/v2/api-docs?group=App

そして実際には、chrome/firefox開発ツールのネットワーク機能ですべてのURLを取得できます。

17
Liping Huang

Mavenを使用する場合、 swagger-maven-plugin を使用して、クライアント側とサーバー側のドキュメント（yaml、json、およびhtml）を生成できます。

これをpom.xmlに追加します。

.....
 <plugin>
                <groupId>com.github.kongchen</groupId>
                <artifactId>swagger-maven-plugin</artifactId>
                <version>3.0.1</version>
                <configuration>
                    <apiSources>
                        <apiSource>
                            <springmvc>true</springmvc>
                            <locations>com.yourcontrollers.package.v1</locations>
                            <schemes>http,https</schemes>
                            <Host>localhost:8080</Host>
                            <basePath>/api-doc</basePath>
                            <info>
                                <title>Your API name</title>
                                <version>v1</version>
                                <description> description of your API</description>
                                <termsOfService>
                                    http://www.yourterms.com
                                </termsOfService>
                                <contact>
                                    <email>[email protected]</email>
                                    <name>Your Name</name>
                                    <url>http://www.contact-url.com</url>
                                </contact>
                                <license>
                                    <url>http://www.licence-url.com</url>
                                    <name>Commercial</name>
                                </license>
                            </info>
                            <!-- Support classpath or file absolute path here.
                            1) classpath e.g: "classpath:/markdown.hbs", "classpath:/templates/hello.html"
                            2) file e.g: "${basedir}/src/main/resources/markdown.hbs",
                                "${basedir}/src/main/resources/template/hello.html" -->
                            <templatePath>${basedir}/templates/strapdown.html.hbs</templatePath>
                            <outputPath>${basedir}/generated/document.html</outputPath>
                            <swaggerDirectory>generated/swagger-ui</swaggerDirectory>
                            <securityDefinitions>
                                <securityDefinition>
                                    <name>basicAuth</name>
                                    <type>basic</type>
                                </securityDefinition>
                            </securityDefinitions>
                        </apiSource>
                    </apiSources>
                </configuration>
            </plugin> ........

次のアドレスで* .hbsテンプレートをダウンロードできます。 https://github.com/kongchen/swagger-maven-example

Mvn swagger：generateを実行すると、JSonドキュメントがプロジェクトの/ generated/swagger /ディレクトリに生成されます。このアドレスに過去： http://editor.swagger.io

そして、あなたが望むものを生成します（お好みのテクノロジーのサーバーサイドまたはクライアントサイドAPI）

9
MK-rou

少し遅れましたが、ブラウザコンソールを開いて、SwaggerドキュメントのJSON定義を返すGETリクエストのURLを見つけることができることを理解しました。 APIをAWS API Gatewayにマッピングするときに、次の手法が役立ちました。

これをする：

  1. Swagger docsエンドポイントに移動します
  2. ブラウザコンソールを開きます
  3. ページを更新
  4. [ネットワーク]タブに移動し、XHRリクエストでフィルタリングします
  5. ?format=openapiで終わるXHRリクエストを右クリックします
  6. これをコピーして、新しいJSONファイルに貼り付けることができます！
7
rlfrahm

でswagger.jsonを取得できるはずです。

http：// localhost：8080/api-docs

ペットストアのサンプルアプリケーションのようにバージョン管理を維持していないと仮定します。その場合、URLは次のようになります。

http：// localhost：8080/v2/api-docs

5
Niccolò

Swaggerが適切に構成されている場合、REST AP​​IのAPI JSON定義を取得します。直接swagger/docs/v1を使用できます。これは、バージョンv1（または単にバージョンを指定する）の場合、完全なURLになることを意味します

http：// localhost：8080/swagger/docs/v1

0
reach2saurabh