smartAPI Editor: A tool for semantic annotation of Web APIs

smartAPI Editor is an an extension to Swagger Editor. Swagger Editor lets you edit your API document in in YAML inside your browser and to preview documentations in real time.

LIVE DEMO

smartAPI editor:

• Validates your API document against smartAPI specifications, an extended version of openAPI specification.

• Lets you Save your API document into smartAPI registry.

• Enhances auto-suggestion functionality for metadata elements by providing the element's conformance level (Required, Recommended, Optional).

• Enhances auto-suggestion functionality for metadata values by suggesting a list of values used by other APIs along with and sorted by their usage frequency.

• Enables semantic annotation of parameters and responses of the API:

  • auto-suggests values for parameters.parameterValueType from identifiers.org along with their usage frequency by other APIs.
  • Integrates the editor with smartAPI profiler which automatically annotates the responses.responseDataType of the API.

Building From Source

Make sure you have Node.js installed. Running the editor:

git clone https://github.com/WebsmartAPI/swagger-editor.git
cd swagger-editor
npm install
chmod 755 scripts/nmchange.sh
./scripts/nmchange.sh
npm start

Make sure you have elasticsearch installed. Running elasticsearch:

./elasticsearch

Running the Identifiers API ( an elasticsearch-based tornado app providing the identifiers from identifiers.org indexed using their names,synonyms, description, and URL)

cd identifiers
make index
make backend

Documentations

• smartAPI Developer Guide
• smartAPI User Guide

Other Swagger Documentations

• Importing your Swagger document
• Development Guide
• Configuration Guide
• Cross Origin Request(CORS) issues

Contributing

LICENSE

---