OpenAPIs tools

API Design tools

Restlet

• (https://restlet.com/)
• Proprietary tools to manage RestFul APIs and Microservises
• Tools:
  • Studio: Online tool to graphically design APIs (paid service)
  • Client: Google Chrome extension to run tests against a HTTP API
  • Cloud: Deploy online API (paid service)

Splitting and merging the specifications

JSON REFS

• “json-refs is a simple library for interacting with JSON References and JSON Pointers. While the main purpose of this library is to provide JSON References features, since JSON References are a combination of Object structure and a JSON Pointer, this library also provides some features for JSON Pointers as well.”
• It will provide JSON resolution also inside YAML files and can output JSON, it is therefore useful to merge different JSON and YAML files into a larger file
• Run on NodeJS
• https://github.com/whitlockjc/json-refs

Install

   $ npm I –g json-refs

Usage

   $ cd folder/with/yaml/tree
   $ json-refs resolve –y anything.split.yaml > anything.merged.yaml 

Swagger-yaml

• https://github.com/idlerun/swagger-yaml
• An alternate structure for defining a Swagger API which splits the definition into separate files which are combined by a NodeJS script prior to processing by the Swagger Generator.

Testing the APIs

Dredd

• http://dredd.readthedocs.io/en/latest/
• HTTP API Testing Framework, Dredd is a language-agnostic command-line tool for validating API description document against backend implementation of the API, Dredd reads your API description and step by step validates whether your API implementation replies with responses as they are described in the documentation.
• Supports OpenAPI and API blueprint files

Postman

• https://www.getpostman.com/
• Automatic HTTP API test suites from JSON files

Swagger-test

• https://www.npmjs.com/package/swagger-test
• Specification-driven REST API testing

Oatts

• https://github.com/noahdietz/oatts
• Generate basic unit test scaffolding for your OpenAPI specification.

Conversions among different formats

AsciiDoctor

• Written in Ruby, Gem available
• http://asciidoctor.org/docs/
• Converts AsciiDoc to many formats, including PDF

Swagger2Markup

• https://github.com/Swagger2Markup/swagger2markup
• Converts openapis into asciidoc or markdown

swagger2RAML

• A swagger2RAML converter tool: https://github.com/8x8Cloud/swagger2raml

OpenApis and RAML two way converters

• https://github.com/mulesoft/oas-raml-converter

Bootprint-openapi

• https://github.com/bootprint/bootprint-openapi
• https://bootprint.knappi.org/
• Converts a openapi-definition into a static html page
• Nodejs
• https://www.npmjs.com/package/bootprint-swagger

Validation

JSON schema validation

• http://json-schema.org/implementations.html
• validating JSON against a JSON schema: An online example can be found at: http://www.jsonschemavalidator.net/. It’s worth noting that the online swagger editor (http://editor.swagger.io) doesn’t validate JSON examples contained within a definition file, since that’s deemed out of scope.
• https://tools.ietf.org/html/draft-newton-json-content-rules-08

Continuous integration

Validating Swagger Specs with Jenkins

• https://drewish.com/2017/03/23/validate-swagger-docs-in-jenkins/
• It uses some bash scripting to send the JSON off to the the Swagger Validator Badge.

Detect breakage between versions of API

• Using Swagger to detect breaking API changes
• https://github.com/civisanalytics/swagger-diff
• https://github.com/zallek/swagger-diff
• https://www.npmjs.com/package/swagger-diff

OpenAPIs and Jenkins

• https://www.getpostman.com/docs/integrating_with_jenkins
• https://vrest.io/