Skip to content

Add Swagger endpoint #65

@RangerMauve

Description

@RangerMauve

It would be helpful if our endpoints were self documenting via swagger.

This is a standard many web services use to make it easy to discover how they work and to auto-generate clients for them. IMO it's a must for any open web service to have.

I'd estimate adding it would take a day or two of effort (maybe less than a day) since we already use schemas in all our endpoints.

We'd just need to add the fastify-swagger endpoint and double check that all the routes are defined properly.

A nice feature is that in addition to the JSON interface, we'd also be getting a standard web UI which would let folks experiment with comapeo cloud without needing to make an app or make http requests manually.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions