API definitions are the communication nexus for you frontend and backend teams, for your API consumers and producers — both inside and outside your company. They are a central element of your API strategy. But authoring good API definitions can be challenging, as you need to know all the details of the underlying specifications.
Restlet offers Restlet Studio, a visual editor for your Swagger API definitions, to ease the authoring of your API contract, as well as help you get started quickly with client SDK and server skeleton code generation, or for translating from other API formats into Swagger.
Although I’m using the term Swagger, I should obviously say Open API Specification! Restlet is a proud founding member of the Open API Initiative — the organization that standardizes the Swagger specification, renamed into “Open API Specification”, under the umbrella of the Linux Foundation. So pardon me if I’m still used to say Swagger instead of OpenAPI Spec!
Instead of writing your Swagger JSON or YAML definitions by hand, textually in a text editor or IDE, Restlet Studio provides a much richer and more interactive experience. Restlet Studio is a visual editor. Use your mouse or keyboard shortcuts to navigate through rich components to edit your endpoints, sections, resources, methods, representations, and more! No need to know all the details of the syntax of Swagger, just navigate through the UI!
If you’re a contract-first advocate, you’ll be able to design your API and quickly get started with both the backend code implementing your API with server skeletons, as well as client SDKs for your consumers to call your API. So you’ll find kits for Java, Android, iOS, Node.JS, Angular.JS, and more.
API definition translation
You might already have an existing Swagger definition, so you can easily import it into Restlet Studio. But it also supports other API formats, and allows you to export your Swagger definition in other formats as well. With Studio, you actually have an API definition translator at your disposal, for when you need to bridge between different worlds, or want to convert from one format to another.
A series of screencasts introduce you to Restlet Studio and its various capabilities:
- a tour of the Restlet Studio UI, to learn more about the interface and where to find its different capabilities
- how to design an API from scratch
- generate client SDKs and server skeletons for your API definition
- translate between different API formats from and into Swagger
A two part tutorial also covers:
- the Web API concepts behind a Swagger definition
- and explains in more details how to craft your own Swagger specification
And of course, you can also read our online documentation for Restlet Studio!
Ready to start the visual experience for your Swagger specs? Launch Restlet Studio!