Apicurio / apicurio-registry

An API/Schema registry - stores APIs and Schemas.
https://www.apicur.io/registry/
Apache License 2.0
604 stars 267 forks source link

Support "usages" as a data-driven way to document how to consume an artifact for a user #716

Open EricWittmann opened 4 years ago

EricWittmann commented 4 years ago

A nice feature in the UI would be a section for "Usage" - similar to what API documentation generators and maven central provide:

image

image

Originally I was thinking we should do something similar just in the UI, but it might be more powerful to make it data-driven and user defined. We could have a new collection in the Registry API like:

/usages

This would be a collection of templates that could be managed by admins of the registry. The UI could pull these templates in order to display customized "usage" information for each artifact. Some possible default "usage" templates might be:

Then admin users could provide their own by POSTing to the /usages endpoint, which is useful if e.g. they are using registry in a .NET or python environment.

EricWittmann commented 4 years ago

Looking for discussion on this from @alesj @carlesarnal @jsenko :)