OpenAPIs tools

From ETSI Forge
Jump to: navigation, search

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

Swagger-test

Oatts

Conversions among different formats

AsciiDoctor

Swagger2Markup

swagger2RAML

OpenApis and RAML two way converters

Bootprint-openapi

Validation

JSON schema validation

Continuous integration

Validating Swagger Specs with Jenkins

Detect breakage between versions of API

OpenAPIs and Jenkins