Discoverability

[kosmotaur]

Hi!

We've created a basic discover page. The use case is, that if we serve the blueprints on our internal network, and people visit its URL, it has been voiced that they could very much use a listing of all the endpoints exposed.

It is a bit rudimentary, and we plan on utilising Aglio to make it a beaut, but didn't want to introduce a dependency that big into Drakov. That's why the -D option accepts a string value, which would be the module to require to build the middleware to handle the discover page. We'll build that module separately.

Kind regards,
@SiCurious and @kosmotaur

[yakovkhalinsky]

Very good! This is something I've been contemplating.

I'll have look over this over the next day 👍

[yakovkhalinsky]

Just thinking we should probably use a reserved path for stuff like this. This also might be good because some users may want to specify / in their API specs.

For examples: http://localhost:3001/drakov which gives you access to the discovery API.

Would be handy to do this so we can then add more paths to this mount point for other functionality that represents drakov specific endpoints.

Let me know what you guys think.

ping @SiCurious @kosmotaur

[yakovkhalinsky]

My other though was that it would be nice (maybe in another PR) to do /drakov?json and just return a JSON object with the endpoint information

[yakovkhalinsky]

@SiCurious @kosmotaur I'm happy to merge this in and we'll change discovery endpoint to the reserved mount point of /drakov if that's cool with you guys

[SiAdcock]

Yeah, that makes sense to me. The JSON discoverability object is a great idea and would help with automated discovery.

[yakovkhalinsky]

Merging now 👍

Will shortly update the routes to use the new reserved mount point of /drakov

Thanks again for the contribution guys 👍

[yakovkhalinsky]

discovery URL mount point changed in 2363cd5