Studio

Design & Document your REST APIs

Launch Restlet Studio
Restlet Studio

Forget about manually writing OpenAPI Specification (OAS, fka Swagger) or RAML code. Visually and collaboratively edit your API contracts, automatically mock and document them, push them to GitHub, generate server skeletons and client SDKs.

  • Contract

    Edit your API contract visually

    Through the design view of Restlet Studio, you visually design and document every aspect of your REST API contract: endpoints, resources, operations and representations. Several variants of a representation can be expressed to support content negotiation between any number of formats such as JSON, YAML or XML. Larger contracts can be split into sections and text elements can be inserted anywhere to facilitate their documentation.

  • Mock your API implementation

    While you are editing your API contract in Restlet Studio you can activate the mocking feature that will automatically simulate the API implementation based on its contract. The data returned is either automatically created or based on the examples that you provided in your contract. Mocks are hosted on Restlet infrastructure and always in sync with your API contract. Mocks make it easier to get your API consumers involved in validating your API designs. They also allow you to start building your frontends before the backend is implemented.

    Mocking API feature
  • Documentation

    Generate your API reference documentation

    Restlet Studio automatically and instantly generates API reference documentations for you. You can easily document an existing API by importing OAS (fka Swagger) or RAML files or you can simply start from a scratch and retro-document your API definitions manually. API reference documentations are hosted on Restlet infrastructure and can be shared privately or publicly, and can be immediately tested using Restlet Client.

  • Collaborate with your team on API contracts

    Restlet Studio runs fully inside any modern web browser. It lets you store your API projects in the cloud and open them from anywhere. You can also share projects with other team members and collaborate over API contracts, for example agreeing on a contract with API consumers before implementation begins. Restlet Studio is integrated with GitHub, which makes it easy to push your API contract to version control, for example to be consumed as part of your DevOps workflow.

    Collaborate
  • SDK

    Generate server skeletons and client SDKs

    Once the API contract is complete, you can bootstrap your API implementation by generating server skeletons for major development stacks such as Java or Node.js. As the key to success for an API is convenience for its consumers, Restlet Studio generates client SDKs for you that are optimized for established mobile and web front end environments such as AngularJS.

  • Translate between API languages

    Although it doesn't require expertise in OAS or RAML, Studio still lets you switch back and forth between these languages at your convenience. With Restlet Studio, API editing is done visually through an intuitive and productive UI. Swagger and RAML sources are automatically synchronized and can be imported and exported in one click, and existing API contracts can be translated between languages, including older versions.

    API

API-First Success Made Easy