openapi-examples
openapi-code-generator
openapi-examples | openapi-code-generator | |
---|---|---|
2 | 5 | |
24 | 13 | |
- | - | |
9.2 | 8.8 | |
6 days ago | 3 days ago | |
TypeScript | ||
- | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
openapi-examples
-
Show HN: Konfig ā SDKs for APIs to write and maintain less API integration
- Directory of SDKs: https://konfigthis.com/sdk/category/all/
For context, we are developer experience enthusiasts and know the pain of searching for an up-to-date SDK for an API, only to find abandoned projects or poorly documented libraries. If you are lucky, some hero developer has published a high-quality SDK, only to eventually fall out-of-date over time, as unpaid work can only last so long.
To generate all the SDKs, we created the highest-quality collection of OpenAPI specifications (https://spec.openapis.org/oas/latest.html) on the internet: https://github.com/konfig-sdks/openapi-examples (it's open and MIT licensed). It contains metadata about the API provider, media assets, response time logs, and the specification itself.
Every specification is modified to ensure that we can create high-quality SDKs. For example, we use LLMs to generate method names for every operation so that the generated SDKs feel natural to use. We then continuously use this dataset to generate SDKs using a generator we have developed over the past 16 months.
Iām excited to know if you have any thoughts or feedback! We also created a Discord server you can join here: https://discord.gg/BAUS4Xtb.
- High-quality and up-to-date OpenAPI specifications for relevant public APIs
openapi-code-generator
-
TypeSpec: A New Language for API-Centric Development
Whilst it's not as expressive/flexible as typespec, and in my experience it's not always well supported by tooling, you can do $ref's across files in openapi specifications.
Eg: https://github.com/mnahkies/openapi-code-generator/blob/main...
-
Show HN: Pre-alpha tool for analyzing spdx SBOMs generated by GitHub
I've become interested in SBOM recently, and found there were great tools like https://dependencytrack.org/ for CycloneDX SBOMs, but all I have is SPDX SBOMs generated by GitHub.
I decided to have a go at writing my own dependency track esque tool aiming to integrate with the APIs GitHub provides.
It's pretty limited in functionality so far, but can give a high level summary of the types of licenses your repository dependencies use, and let you drill down into potentially problematic ones.
Written in NextJS + mui + sqlite, and using another project of mine to generate most of the API boilerplate/glue (https://github.com/mnahkies/openapi-code-generator)
-
Show HN: Konfig ā SDKs for APIs to write and maintain less API integration
Congratulations on launching, you have some interesting ideas in there.
Using a LLM to generate missing operation ids isn't something I've tried, instead I simply combine http method plus path segments which at least guarantees uniqueness [1]. I do a similar thing for extracting and naming inline schemas based on the operation and media types [2].
How do you prevent naming collisions? And do you find the resulting names to be significantly better than a deterministic approached like I described?
I'll definitely checkout the curated specifications - always useful to get more high quality (and hopefully varied) specifications to test my code generator with, and the lint rules is a great idea - I've had to explain what patterns lend themselves well to code generation many times.
I'm on mobile so may have missed it, but looking at one of your typescript examples I couldn't see any runtime response body validation, is this something you're thinking about?
- [1] https://github.com/mnahkies/openapi-code-generator/blob/main...
-
Write OpenAPI with TypeSpec
Yeah I'm also on the schema first side of the debate.
I think for me it comes down to a few key points:
- APIs are forever, the choice of language/framework is an implementation detail
- Constraining yourself to what can be represented in the specification is better than generating a specification from implementation that may not be capable of expressing the full details
- When working with diverse languages it provides a common ground/language for discussing API changes. Eg: if you have java backend, kotlin android, swift iOS, react/whatever web you can bring everyone together with the spec
- Subjective, but a good spec will include a bunch of documentation and examples that tend to create a lot of noise in the code. I personally prefer to keep this in the spec and the implementation smaller
I think the main counterpoint to this is that you can generate the spec and then take that and change your mind if you later change language/framework etc - it's not a one-way door.
My biggest bug bear is that regardless of spec first or implementation first, you should have something you write once and generate the rest of the glue from (eg: docs, client sdks). Writing each piece manually/independently always leads to drift and bugs.
(I'm working on my own little openapi -> typescript code generator over here https://github.com/mnahkies/openapi-code-generator - eventually plan to support more than typescript, and adding typespec support is something I'm currently considering)