Comment générer swagger.json

Je suis en utilisant java spring boot cadre pour créer des api REST pour mon projet et je suis à l'aide de "springfox-swagger2 et springfox-swagger-ui" pour générer de la supériorité de la documentation. Je suis capable de voir ma documentation à l'aide de l'url http://localhost:8080/swagger-ui.html.

Comment puis-je caisse ou de générer swagger.json /spec.json, La documentation ne doit pas être avec cette application, nous utilisons une application séparée pour l'inscription de l'api docs

OriginalL'auteur Bikesh M Annur | 2017-01-23

14

Vous pouvez obtenir l'url avec votre swagger-l'interface utilisateur de la page html:
```
GET http://localhost:8080/v2/api-docs?group=App
```
Et en fait, vous pouvez obtenir toutes les url avec chrome/firefox développer des outils du réseau.

Comment voulez-vous télécharger l'arrogance.json / spec.des fichiers json à partir de cette url?
Dans le navigateur, tapez l'URL complète.. et vous obtenez JSON comme réponse. Qui peut couper et coller comme fichier json

OriginalL'auteur Liping Huang
4

Je suis un peu en retard, mais je viens de comprendre que vous pouvez ouvrir votre navigateur de la console et de trouver l'URL de la requête GET qui renvoie du JSON définition pour votre Swagger docs. La technique suivante a fonctionné pour moi lors de la cartographie de mon API d'API AWS Passerelle.

Pour ce faire:
1. Accédez à votre Swagger docs extrémité
2. Ouvrez le navigateur de la console
3. Actualiser la page
4. Accédez à l'onglet réseau et filtrer par XHR demandes
5. Clic droit sur la demande XHR qui se termine dans ?format=openapi
6. Désormais, vous pouvez simplement copier et coller dans un nouveau fichier JSON!
+ vous devez copier le corps de la Réponse du contenu de la demande XHR, où le JSON est disponible

OriginalL'auteur rlfrahm

Je l'ai fait avec une petite astuce

J'ai ajouté le code suivant à la fin de ma maison contrôleur de cas de test

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();
        }

    }

}
}

Je ne sais pas ce qui est juste ou non, Mais il fonctionne 🙂

Dépendance

    <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>

OriginalL'auteur Bikesh M Annur

Si vous utilisez Maven, vous pouvez générer client et côté serveur de la documentation (yaml, json et html) à l'aide de swagger-maven-plugin

Ajouter à votre 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> ........

Vous pouvez télécharger *.hbs modèle à cette adresse:
https://github.com/kongchen/swagger-maven-example

Exécuter mvn swagger:générer
JSon documentation seront générées à votre projet /generated/swagger/répertoire.
Passé sur cette adresse :
http://editor.swagger.io

Et de générer ce que jamais vous le souhaitez ( côté Serveur ou côté Client de l'API dans votre choix de la technologie )

Ce qui semble sorte de mal à l'aise, vu que j'ai documenté tout mon API avec Swagger2 annotations.
le plugin prend entièrement en charge Swagger2 des annotations à un swagger.json

OriginalL'auteur MK-rou

1

Vous devriez être en mesure d'obtenir votre swagger.json à

http://localhost:8080/api-docs

en supposant que vos n'avez pas gardé le doublage que dans le magasin pour animaux de compagnie exemple d'application. Dans ce cas, l'URL devrait être:

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

OriginalL'auteur Niccolò

Vous devez vous connecter pour publier un commentaire.