Show HN: API Docs for NASA's Astronomy Picture of the Day API

https://nasa-apod.portaldocs.dev

by vrepsys • 5 years ago

18 3 5 years ago

nasa-apod.portaldocs.dev

vrepsys• 5 years ago

Hey HN,

I'm building a tool to render Stripe-like API docs from OpenAPI/Swagger files.

I thought that the best way to get people to discover my tool and be useful at the same time is to build docs for various open APIs. (Let me know if you need API docs for your open, or even better, an open source API, and I'll make it happen!).

How it works:

- The OpenAPI/Swagger is stored on S3 and rendered on the server-side using NextJs (on Vercel).

- I use NextJs's incremental static rendering (ISR) to render the doc in the background.

- NextJs's middleware (a new thing in NextJs 12) routes the request to an appropriate route based on the subdomain.

- I'm looking to make the docs generator an open source in the future, when I build out the editing feature which will be paid.

Any feedback/thoughts highly appreciated!

henrykuzmick• 5 years ago

Looks well designed. But in documentation content remains king, the looks (IMO) always comes second.

Lizdeika• 5 years ago

I'd add that well thought out layout along with content are quite important. Personally I can't stand documentations that are hard to navigate to find the important stuff.

Show HN: API Docs for NASA's Astronomy Picture of the Day API

Related Stories