Expand Example Documentation at "openapi-ts.dev/examples"

[bennobuilder]

Changes

The example documentation on the openapi-typescript homepage has been expanded to include:

1. Addition of feature-fetch in the Data Fetching section (Example)
2. Two new sections:
   • Hono with @bldc/openapi-router (Example)
   • Express with @bldc/openapi-router (Example)

The goal is to showcase additional examples that might bring value to the openapi-typescript user. Further expansion will be based on your (@drwpow) feedback and whether you think this additions can bring value to your users.

cheers

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2844c14

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[bennobuilder]

Hey @kerwanp @drwpow,

Do you think this addition to the example docs would bring value to the community? If not, feel free to close this Draft.

Thanks 😊

[drwpow]

Ah sorry; didn’t realize this was ready for review as a draft. In the future, please just open a full PR so we know it’s ready for feedback.

This is great! I’m so excited to see more libraries take this approach, and thanks for bringing this library to our attention! We’ll always add other library recommendations like this provided they have an open license. More options in OSS helps everyone, and the “competition” makes the internet better 🙂.

Will mark as ready for review, and I think as-written this is good, but just let me know when you’d like to merge it and I’d be happy to.

[bennobuilder]

Ah sorry; didn’t realize this was ready for review as a draft. In the future, please just open a full PR so we know it’s ready for feedback.

This is great! I’m so excited to see more libraries take this approach, and thanks for bringing this library to our attention! We’ll always add other library recommendations like this provided they have an open license. More options in OSS helps everyone, and the “competition” makes the internet better 🙂.

Will mark as ready for review, and I think as-written this is good, but just let me know when you’d like to merge it and I’d be happy to.

Yeah, sorry for the confusion. The draft was intended to check if you guys are open to including libraries I created in your example section (as stated in the description). I believe they could benefit users of openapi-typescript, but I was unsure whether you guys had the same view.

I’ve updated the example documentation, and the PR is now ready for review.

cheers :)

As a site note, the benchmark from here seems to be a bit outdated? On my machine (MacBook M3 Pro) for example openapi-typescript-fetch was the fastest (see image) and it also got more lightweight.

[drwpow]

The draft was intended to check if you guys are open to including libraries I created in your example section (as stated in the description). I believe they could benefit users of openapi-typescript, but I was unsure whether you guys had the same view.

I’m a big believer in promoting each others’ open source work, because that’s the spirit of what we’re doing! If people take this code, and build off of it, or develop their own libraries, that’s the entire point! 😄 Everyone only benefits from more libraries. And if they’re philosophically aligned like your library is to this project, even better 😎

As a site note, the benchmark from here seems to be a bit outdated?

It’s not outdated per se; just flaky. We are working on improving it here: #1818. Thoughts welcome, but I am now suspicious of msw (unconfirmed) playing a part in the flakiness. We’ll improve the benchmarks across the board.

Oh but you’re right—openapi-typescript-fetch did get a recent update that sped it up by quite a bit. Didn’t mean to deny them of that; we should update the benchmarks we have 😅. But I also would like to spend more time on #1818 so we get more reliable numbers overall.

[drwpow]

Looks great! Thanks for the improvements to the docs as well.

Will merge this, but feel free to add any followups if needed