Prominent operation name in document?

[dougbreaux]

Is it just me, or is it unhelpful that the individual operation names are not prominently displayed in the main documentation area? e.g. right here in this whitespace, I want the operation name that is shown over in the "Try this"/example area:

[EricWittmann]

Thanks for the feedback, @dougbreaux - what I'll say is that we use ReDoc to generate the documentation, so this kind of thing would need to be submitted over there. I think the idea is that the operation name/subject is shown in the main area, and the operation details on the right. I actually agree with you because I find the technical information more interesting than the friendly human name. But we may be in the minority. Here's another example:

[dougbreaux]

I don't know, API docs are by definition for technical people, aren't they? I'm liking Apicurio as a collaborative editor, but I'm somewhat missing SwaggerHub-formatted docs ☹️

In fact, for me, I'd rather have the operation names than the summaries in the left menu area too.

I'll go look over at Redoc and see if such things have been raised, or possibly raise them myself.

[EricWittmann]

Another thing to mention is that it was always my intention to support additional documentation visualizers in Apicurio Studio. For example, ReDoc is the default but we also support rapidoc. To preview that feature (only available as an option to the Preview feature, not the Sharing feature) just add &rid=rapidoc to the preview URL. So for example, I have a preview URL like this (you won't have access to this because you're not a collaborator on my API definition):

https://studio.apicur.io/preview?aid=25572

But if I just make that URL this:

https://studio.apicur.io/preview?aid=25572&rid=rapidoc

Then it will use rapidoc instead of ReDoc for the visualization.

I've always wanted to explore this feature more, perhaps allowing end users to set a default visualizer somewhere, or just making it easier to switch. I haven't found the time. Also it would be good to support Swagger UI. I personally hate the Swagger UI user experience, but I know others really like it.

I'd be very open to helping with a contribution if you're interested. :) If not that's fine too, just keep poking this GH issue until we find time to do it...

[dougbreaux]

Thanks, that alternate view looks nice too. I haven't looked enough to see whether it resolves all my irritations. I also see my redoc issue has has no apparent activity at all ☹️

[dougbreaux]

Is there any way to get that alternate visualizer in the shared URL, as opposed to the preview URL?