Meet Yizy, a brand new browser based,free, open-source tool  that makes designing APIs a breeze; code generation and AI included.

At IProgrammer we are fans of API related tooling. In the past we've examined tools like OpenAPI Diff, Step CI, AWS Smithy and Redocly CLI. Well here's yet another one worth of mention.
Yizy. It's a browser-based tool that enables:

• Writing API Spec in the browser with code completion.
• Generating model definition and client SDK from documentation
• Chat with a LLM that knows about your API Spec

Therefore, at the same time you can build API documentation, client SDKs and use context aware AI.

While all those functionalities are available from within the same UI they're actually three distinct components:

Yizy Doc
Write specs in the Yizy propriety but human readable format by just filling out a form in the browser. Code completion aware, no more YAML or JSON, although you can export the specification in JSON format and version control it with Git.

Yizy Generator
Yizy’s deterministic code generators produce server and client SDKs based on the Yizy document spec. Currently only Typescript is supported but new languages are coming.

Yizy AI
Yizy’s built in AI assistant that is trained on your API specifics. This allows for tasks like generating curl commands by prompting. Let's say that there's an endpoint that retrieves Person entities by Name. I can then be specific about it and ask:

how do I search for a person by name? show me by crafting a request using Curl.

Other tasks you can do with AI is crafting test requests, seeking help on the generated SDKs, etc. Requires an Anthropic API Key.

Really there's not much to it. The interface is clean and intuitive and very easy to use, and in comparison with other OpenAPI schema first designers it is much more easy to work with.
You can grab the code from its Github repo and self-host it or use the online version for free.

More Information

Yizy

Yizy github

Related Articles

OpenAPI Diff Prevents API Breakages 

To be informed about new articles on I Programmer, sign up for our weekly newsletter, subscribe to the RSS feed and follow us on Twitter, Facebook or Linkedin.

Comments

Make a Comment or View Existing Comments Using Disqus

or email your comment to: comments@i-programmer.info