fp.

I shared a previous version of yapi a few months ago in the comments section of a post talking about the insanity of Postman being 'down'. yapi has developed into a more mature project since then!

https://github.com/jamierpond/yapi

Still very early, but it makes me much more productive vs Postman, Bruno, Insomnia, etc.

If youre a nvim/tmux culture human, you might like this!

Comments

dhruv3006•1mo ago

Great to see this space so active !

Building something similar : https://voiden.md

jamiepond•1mo ago

This is a really interesting approach! How did you end up deciding on executable markdown as opposed to other approaches?

dhruv3006•1mo ago

well - the point is. that we wanted to be standards compliant - and want to use existing technologies without actually reiventing a new standard or a proprietary format. (like some of the other api clients took).

and moreover we had this fundamental idea that documentation and testing should be in a single source of truth to avoid documentation drift (not just the spec drift).

And hence we came up with the idea of using markdown as the baseline and doing everything around it.

gregopet•1mo ago

Is there a way to generate code from these specs? Perhaps via OpenAPI, Smithy, something like that?

dhruv3006•1mo ago

By code you mean voiden markdown, right ? We do have a OpenAPI schema feature where we support to generate voiden files right now.

We have it in beta now : https://voiden.md/download (Only Linux and Mac)

And in the future we also plan to support graphQL but not smithy for now.

gregopet•1mo ago

Well, no. I mean something I can stick in my actual code to ensure it matches the spec, be it through validation, strongly typed interfaces, unit tests or some other mechanism.

Also, while a nice API document is a godsend (and sadly often missing in practice), a way to generate the consuming side of the API (again via various mechanisms) is also a very useful thing.

Re-reading the page, perhaps I got it wrong and it works the other way around? Voiden uses e.g. OpenAPI files and verifies it's still compliant with them? That would work, although it's a bit of a double effort.. still, useful in many cases.

Terretta•1mo ago

Love this.

As a literate code aligned shop, we wish more tools adopted these values for knowledge-base-adjacent tasks.

// Love OP's CLI too!

dhruv3006•1mo ago

Thank youuu !

We are open to feedback : https://github.com/VoidenHQ/feedback

bbkane•1mo ago

Looks neat! I highly recommend showcasing the interactivity with a few GIFs in your README. You can script them with https://github.com/charmbracelet/vhs

McNulty2•1mo ago

honzajde•1mo ago

Very nice. Just did not find the spec/format for the config file.

Celeo•1mo ago

I'm getting a 404 with the submitted link, but am able to view the homepage at https://yapi.run/.

jamiepond•1mo ago

Thank you for commenting about the 404. I'm serving the blog using a [custom package that serves your blog from GitHub hosted mark down](https://github.com/jamierpond/madea-blog-core) which was getting it's debut. There was a bug in caching requests to GitHub.

avtar•1mo ago

Hurl's another great option for this https://hurl.dev/

deltaknight•1mo ago

This looks super cool, I’ve played around with making custom API clients/executers in multiple teams now and am glad to see something that I might actually use instead of re-rolling my own each time.

One thing I’ve previously found very useful is the ability to select multiple ‘environments’ at once (I’ve previously split this in to e.g. environment+session or environment+user before). The ability to merge a set of variables together lets you define variables for _where_ I’m calling (local, staging, etc), but also who/what I’m calling (specific users, types of profiles/packages (how does this api behave if I switch between a free vs paid licence), etc).

Also echoing another comment, the blog linked gives me a 404 page now. Additionally, the GitHub for this projects seems have a ton of blank issues saying “help yapi made me too productive”? Rather odd, I probably won’t be running this project directly anytime soon…

chaz6•1mo ago

Page currently shows

    404 This page could not be found.

davidpfarrell•1mo ago

Anyone else getting 404 when clicking the title[0] ?

[0]: https://yapi.run/blog/what-is-yapi

mh9r•1mo ago

I love file-based API clients. I think it’s only time to define a standard file format that all or most IDEs, editors and clients support. Fragmentation between IntelliJ, VSCode and any other tool makes the approach less useful as it could be.

jamiepond•1mo ago

Yes! Exactly :) That is my plan.