Generieren Yaml oder Json-Datei von Swagger Dokumentation

Habe ich developpe einige Rest-web-service, dokumentiert durch stolzieren, mit Fors-springmvc annotions.
Nun, ich will swagger-editor zum generieren von client-side-Rest-web-service-code, aber swagger-editor benötigen, Yaml oder Json-Datei. Wissen Sie, ob es einen Weg gibt, um diese Datei zu generieren ?
Vielen Dank im Voraus

EDIT :
Es kann erfolgen, indem swagger-mvn-plugin , aber ich habe nicht gefunden, ein Beispiel, wie es zu tun ?

InformationsquelleAutor MK-rou | 2015-12-17
  1. 6

    Ich Antworte mir selbst 🙂 . Sie können generieren von client-und server-seitige Dokumentation (yaml, json und html) durch Verwendung Fors-maven-plugin

    Fügen Sie diese zu Ihrem 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>your-email@email.com</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> ........

    Können Sie herunterladen *.hbs-Vorlage an diese Adresse:
    https://github.com/kongchen/swagger-maven-example

    Ausführen mvn swagger:generate
    Json-Dokumentation generiert wird, bei Ihrem Projekt /generated/swagger/ - Verzeichnis.
    Vergangenheit, die Sie an diese Adresse :
    http://editor.swagger.io

    Und zu generieren, was immer Sie wollen (Server-seitig oder Client-side API in Ihre bevorzugte Technologie)

    InformationsquelleAutor MK-rou
Schreibe einen Kommentar