Comment faire pour importer Swagger Api en Facteur?

J'ai récemment écrit restful Api avec spring mvc et swagger-ui(v2). J'ai remarqué que la fonction d'Importation dans le Postier:

Donc ma question est de savoir comment créer le fichier Facteur nécessaire?

J'ai essayé de googler, mais pas de réponses applique à ma situation.

En passant,je ne suis pas familier avec swagger.

L'homme c'est vraiment génial ... !!!

InformationsquelleAutor Demon Coldmist | 2016-08-22

postman swagger

Je travaille sur PHP et ont utilisé Swagger 2.0 du document de l'Api.
L'Arrogance Document est créé à la volée (c'est du moins ce que j'utilise en PHP). Le document est généré dans le format JSON.

Exemple de document

{
    "swagger": "2.0",
    "info": {
    "title": "Company Admin Panel",
        "description": "Converting the Magento code into core PHP and RESTful APIs for increasing the performance of the website.",
        "contact": {
        "email": "[email protected]"
        },
        "version": "1.0.0"
    },
    "host": "localhost/cv_admin/api",
    "schemes": [
    "http"
],
    "paths": {
    "/getCustomerByEmail.php": {
        "post": {
            "summary": "List the details of customer by the email.",
                "consumes": [
                "string",
                "application/json",
                "application/x-www-form-urlencoded"
            ],
                "produces": [
                "application/json"
            ],
                "parameters": [
                    {
                        "name": "email",
                        "in": "body",
                        "description": "Customer email to ge the data",
                        "required": true,
                        "schema": {
                        "properties": {
                            "id": {
                                "properties": {
                                    "abc": {
                                        "properties": {
                                            "inner_abc": {
                                                "type": "number",
                                                    "default": 1,
                                                    "example": 123
                                                }
                                            },
                                            "type": "object"
                                        },
                                        "xyz": {
                                        "type": "string",
                                            "default": "xyz default value",
                                            "example": "xyz example value"
                                        }
                                    },
                                    "type": "object"
                                }
                            }
                        }
                    }
                ],
                "responses": {
                "200": {
                    "description": "Details of the customer"
                    },
                    "400": {
                    "description": "Email required"
                    },
                    "404": {
                    "description": "Customer does not exist"
                    },
                    "default": {
                    "description": "an \"unexpected\" error"
                    }
                }
            }
        },
        "/getCustomerById.php": {
        "get": {
            "summary": "List the details of customer by the ID",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "description": "Customer ID to get the data",
                        "required": true,
                        "type": "integer"
                    }
                ],
                "responses": {
                "200": {
                    "description": "Details of the customer"
                    },
                    "400": {
                    "description": "ID required"
                    },
                    "404": {
                    "description": "Customer does not exist"
                    },
                    "default": {
                    "description": "an \"unexpected\" error"
                    }
                }
            }
        },
        "/getShipmentById.php": {
        "get": {
            "summary": "List the details of shipment by the ID",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "description": "Shipment ID to get the data",
                        "required": true,
                        "type": "integer"
                    }
                ],
                "responses": {
                "200": {
                    "description": "Details of the shipment"
                    },
                    "404": {
                    "description": "Shipment does not exist"
                    },
                    "400": {
                    "description": "ID required"
                    },
                    "default": {
                    "description": "an \"unexpected\" error"
                    }
                }
            }
        }
    },
    "definitions": {

    }
}

Cela peut être importé dans Postier comme suit.

Cliquez sur "Importation " bouton dans le coin supérieur gauche du Facteur de l'INTERFACE utilisateur.
Vous verrez plusieurs options pour importer la doc API. Cliquez sur " Coller du Texte Brut'.
Coller le format JSON dans la zone de texte et cliquez sur importer.
Vous verrez toutes vos Api comme "Facteur Collection " et peut l'utiliser à partir du Facteur.

Comment faire pour importer Swagger Api en Facteur?

Vous pouvez également utiliser "Importer à Partir d'un Lien". Ici, collez l'URL du site qui génère le format JSON de l'Api à partir de l'Arrogance ou de toute autre API Document de l'outil.

C'est mon Document (JSON) de génération de fichier. C'est en PHP. Je n'ai aucune idée de JAVA avec Swagger.

<?php
require("vendor/autoload.php");
$swagger = \Swagger\scan('path_of_the_directory_to_scan');
header('Content-Type: application/json');
echo $swagger;

merci, mais maintenant le problème est de savoir comment pourrais-je exporter le fichier de swagger-l'interface utilisateur?Et le lien est inutile.
J'ai ajouté le code pour générer de l'API. Fondamentalement, il scanne l'intégralité du répertoire, vérifie les annotations et rend le JSON/YAML de sortie. Désolé, mais je n'ai pas utilisé Swagger avec JAVA.
merci, si elle pouvait être à l'exportation en PHP, donc ne Java. Je vais le traduire en Java.
Dans une application java à l'aide de la springfox-swagger2 de dépendance, vous pouvez obtenir le JSON à l'importation dans le Postier comme décrit dans cette réponse, en ouvrant un navigateur et de se diriger vers localhost:8080/v2/api-docs
Merci, l'importation de réussir, mais il n'est pas de générer des "corps" de l'info dans postier pour n'importe quel POSTE de l'API. des idées?

InformationsquelleAutor JDpawar

Accepté la réponse est correcte, mais je vais réécrire la procédure complète pour java.

Je suis actuellement en utilisant Swagger V2 avec Spring Boot 2 et il est simple processus en 3 étapes.

Étape 1: Ajouter les dépendances requises dans pom.xml fichier. La deuxième dépendance est facultatif ne l'utilisez que si vous avez besoin d' Swagger UI.

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

Étape 2: Ajouter une configuration de classe

@Configuration
@EnableSwagger2
public class SwaggerConfig {

     public static final Contact DEFAULT_CONTACT = new Contact("Usama Amjad", "https://stackoverflow.com/users/4704510/usamaamjad", "[email protected]");
      public static final ApiInfo DEFAULT_API_INFO = new ApiInfo("Article API", "Article API documentation sample", "1.0", "urn:tos",
              DEFAULT_CONTACT, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList<VendorExtension>());

    @Bean
    public Docket api() {
        Set<String> producesAndConsumes = new HashSet<>();
        producesAndConsumes.add("application/json");
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(DEFAULT_API_INFO)
                .produces(producesAndConsumes)
                .consumes(producesAndConsumes);

    }
}

Étape 3: l'Installation est terminée et vous devez à présent document Api dans controllers

    @ApiOperation(value = "Returns a list Articles for a given Author", response = Article.class, responseContainer = "List")
    @ApiResponses(value = { @ApiResponse(code = 200, message = "Success"),
            @ApiResponse(code = 404, message = "The resource you were trying to reach is not found") })
    @GetMapping(path = "/articles/users/{userId}")
    public List<Article> getArticlesByUser() {
       //Do your code
    }

Utilisation:

Vous pouvez accéder à vos Documents à partir de http://localhost:8080/v2/api-docs il suffit de le copier et de le coller dans le Facteur d'importer de la collection.

Comment faire pour importer Swagger Api en Facteur?

Facultatif Swagger UI: Vous pouvez également utiliser autonome de l'INTERFACE utilisateur, sans autre repos client via http://localhost:8080/swagger-ui.html et il est assez bon, vous pouvez héberger vos documents sans aucun tracas.

Comment faire pour importer Swagger Api en Facteur?

InformationsquelleAutor UsamaAmjad

0
- Cliquez sur le bouton orange ("sélectionner des fichiers")
- Parcourir à l'Arrogance doc (swagger.yaml)
- Après avoir sélectionné le fichier, une nouvelle collection est créée en FACTEUR. Il contiendra les dossiers sur la base de vos points.
Vous pouvez également obtenir de l'échantillon swagger des fichiers en ligne afin de vérifier cette(si vous avez des erreurs dans votre swagger doc).
- pourriez-vous me montrer le chemin comment exporter l'arrogance.yaml?Je suis à l'aide de swagger-ui dans spring mvc.
- où voulez-vous exporter swagger à partir de? vous utilisez déjà swagger pour la création de votre YAML?
InformationsquelleAutor Ashwini Kumar

Vous devez vous connecter pour publier un commentaire.