web-dev-qa-db-fra.com

Comment puis-je générer du swagger basé sur le facteur existant?

Je développe une API REST. Au cours du développement, j’ai utilisé postman (extension chrome) pour utiliser et documenter mon API. C'est un outil formidable et la plupart des points finaux y figurent. release Je voudrais documenter cette API en swagger, comment puis-je faire cela? Y a-t-il un moyen de générer un swagger basé sur l'exportation postman?

swaggerswagger-uipostmanswagger-2.0
50
StuBob

Quelqu'un a posté ce lien (et l'a supprimé?): http://restunited.com/

Il accepte le facteur JSON et le convertit en swagger. Cela semble être ce que je cherchais.

9
StuBob

APIMatic API Transformer peut traiter une collection Postman (v1 ou v2) en tant que format d'entrée et générer Swagger 1.2 ou 2.0, et maintenant OpenAPI 3.0.0 en sortie.

Il possède sa propre API et une interface Web, ainsi qu'une version en ligne de commande .

55
MikeRalphson

Vous pouvez utiliser https://github.com/stoplightio/api-spec-converter avec le code

var transformer = require('api-spec-transformer');

var postmanToSwagger = new transformer.Converter(transformer.Formats.POSTMAN, transformer.Formats.SWAGGER);

postmanToSwagger.loadFile('/path/to/your.json.postman_collection', function(err) {
  if (err) {
    console.log(err.stack);
    return;
  }

  postmanToSwagger.convert('yaml')
    .then(function(convertedData) {
      // convertedData is swagger YAML string
      console.log(convertedData);
    })
    .catch(function(err){
      console.log(err);
    });
});
8
plotnik