Edit References

With DeveloperHub you can edit your OpenAPI 2/3 definitions using our editors. We support two different editors:

• DeveloperHub API Editor: Supports all OpenAPI specifications including v3.2. Text based running on a powerful VSCode environment with built-in linting, outline and go to definition features. The API editor is a free tool that can also be accessed without logging into DeveloperHub.

• Visual API Editor: Supports OpenAPI specifications up until 3.0.3. Powered by Apicurio, it's a visual editor for a lower learning curve. It helps you build the schema of your OpenAPI reference without needing to know the ins and outs of the specification.

Editing an API Definition

To edit an existing API definition:

• From the sidebar, choose Reference .
• Choose the API Reference to be edited from the list.
• Once the API Reference has loaded, click on Edit in the bottom right side of the screen. The API Editor will load in a new tab.
• Make the changes. Click Save Draft when done.

Once you are ready to publish the API Reference, a publisher may click Publish button on the API Reference.

Create a new API Definition

To create a new API definition using our OpenAPI editor:

• From the sidebar, choose Reference .
• Choose "Create new OpenAPI 3 reference". The API editor will launch in a new tab.

Generators

Do you prefer to generate the OpenAPI file directly from code so it is always up to date with your codebase? Here are a few generators from source-code:

• Javascript: swagger-jsdoc
• Express: swagger-express
• PHP: swagger-php
• Symfony: NelmioApiDocBundle
• Django: django-rest-swagger
• Flask: flask-restplus
• Ruby On Rails: openapi-rails
• Go: go-swagger
• Spring: springfox

You can use our API to upload API references automatically.