AllBugsFeaturesChangelogSearchNew post
Sign in with Fluxer
Features

[API] Swagger/OpenAPI Docs

(#915) Feature Shipped api
by RexSystem edited originally by @ktwrd on GitHub

Problem

Currently the API is changing frequently, and it doesn't match what's currently in the repo.

Proposed solution

Support for Swagger/OpenAPI documentation, so it's easier for library maintainers to figure out if issues are on their end, or if it's something broken on the API. An example:

Notes (optional)

Thought of this solution, since the /instance API endpoint was removed sometime within the last 24hr, but the InstanceController file hasn't been updated.

6 comments

Sign in with Fluxer to comment and vote.
Comment by @ktwrd
RexSystem 1 vote edited originally by @ktwrd on GitHub OP
Awesome idea! I just wanted to mention that there’s also https://github.com/scalar/scalar as an alternative to Swagger UI. Happy to help here :)
@xC0dex Yep that's why I said OpenAPI docs so anyone can use whatever frontend they'd like :3 I have no idea how it would be implemented with Fluxer, since I don't really know anything about the Hono framework, but I assume that it would be possible. Also having OpenAPI docs would make it significantly easier for contributors and/or Hampus to work on the documentation.
Permalink
Comment by Hampus
HampusStaff 1 vote originally by @hampus-fluxer on GitHub
This is now outdated since a very long time. Everything is auto-generated from the code. Closing!
Permalink