Taking a Look at the Stoplight API Spec Editor
I'm tracking best practices so that when someone steps up and works on an open, embeddable solution, they can learn from me about what's working or not across the space.
Join the DZone community and get the full member experience.Join For Free
I'm keeping an eye on the different approaches by API service providers when it comes to providing API editors within their services and tooling. While I wish there was an open-source GUI API editor out there, the closest thing we have is from these API service providers, and I am trying to track what the best practices are so that when someone does step up and begin working on an open, embeddable solution, they can learn from my stories about what is working or not working across the space.
One example I think has characteristics that should be emulated is the API Spec Editor from Stoplight. The GUI editor lets you manage all the core elements of an OpenAPI, like the general info, host, paths, and even the shared responses and parameters. They even provide what they call a CRUD builder where you paste the JSON schema, and they'll generate the common paths you will need to create, read, update, and delete your resources. Along the way, you can also make calls to API endpoints using their interactive interface, helping ensure your API definition is actually in alignment with your API.
The Stoplight API Spec Editor bridges the process of defining your OpenAPI for your operations, with actually documenting and engaging with an API through an interactive client interface. I like this approach to coming at API design from multiple directions. Apiary first taught us that API definitions were about more than just documentation, and I think our API editors should keep evolving on this concept and allowing us to engage with any stops along the API lifecycle like we are seeing from API service providers like Restlet.
I'm already keeping an eye on Restlet and APIMATIC's approach to providing a GUI API design editor within their solutions and will keep an eye out on other providers as I have time. Like other areas of the API sector, I'm hoping I can develop a list of best practices that any service provider can follow when developing their tools and services.
Published at DZone with permission of Kin Lane, DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.
VPN Architecture for Internal Networks
Mastering Time Series Analysis: Techniques, Models, and Strategies
Top 10 Pillars of Zero Trust Networks
Front-End: Cache Strategies You Should Know