4 ms·

Shameless plug: here's my indie-project that converts an OpenAPI/Swagger spec into something that aims to look like Stripe's API Reference: https://portal.dev

Shameless plug: here's my indie-project that converts an OpenAPI/Swagger spec into something that aims to look like Stripe's API Reference: https://portal.dev https://portal.dev Here are a couple of example docs: https://space-api.portaldocs.dev https://space-api.portaldocs.dev (and the OpenAPI behind it: https://github.com/portaldev/nasa-apod-api-docs/blob/main/openapi.yaml https://github.com/portaldev/nasa-apod-api-docs/blob/main/op...) https://recur-api-beta.portaldocs.dev https://recur-api-beta.portaldocs.dev At my previous workplace we've built the whole docs portal (including the API reference) as a custom static website with Contentful (a json CMS) underneath. It was a real pain in the ass to edit and maintain, that's how I got the idea.

wdb 5y ago
I wish there was an open-source solution something like this or similar to Readme.com but better than Redocly
- vrepsys 5y ago
  I'm considering of making the OpenAPI->API Reference converter an Open Source project, and then charging only if you need advanced features, like wysiwyg/inline editing, change approvals, automatic testing of the examples in the docs etc. It's just that I'm not sure I can do it until I have these advanced features. If I can't make money out of this I have to return to my day job, and stop developing portal.dev.
atombender 5y ago
This looks great. But I wish there were a self-hosted version. I work on a project that could use this, but it would really need to be tightly integrated with our existing hosting, I think.
- vrepsys 5y ago
  Appreciate the feedback. Would it work for you if you could export this as a static website that you could run on your own servers? (you could do that in a Github action), or, alternatively, use some sort of React component that renders the API docs in your app?
  - atombender 5y ago
    I think ideally a CLI tool to build the static website locally, which can then be deployed anywhere.

wdb 5y ago

I wish there was an open-source solution something like this or similar to Readme.com but better than Redocly

vrepsys 5y ago
I'm considering of making the OpenAPI->API Reference converter an Open Source project, and then charging only if you need advanced features, like wysiwyg/inline editing, change approvals, automatic testing of the examples in the docs etc. It's just that I'm not sure I can do it until I have these advanced features. If I can't make money out of this I have to return to my day job, and stop developing portal.dev.

atombender 5y ago

This looks great. But I wish there were a self-hosted version. I work on a project that could use this, but it would really need to be tightly integrated with our existing hosting, I think.

vrepsys 5y ago
Appreciate the feedback. Would it work for you if you could export this as a static website that you could run on your own servers? (you could do that in a Github action), or, alternatively, use some sort of React component that renders the API docs in your app?
- atombender 5y ago
  I think ideally a CLI tool to build the static website locally, which can then be deployed anywhere.