Skip to content

Prefix for request paths #315

Open
Open
@kylemacey

Description

@kylemacey

We use an API that is connected to by specifying a version in the path /api/v1/users.

I'd like to simplify the way the documentation is generated, making it look a little cleaner by not always including api/v1 in each header. We can document how to specify a version in the root of the documentation

For example, I want to be able to write my tests like this:

get "/api/v1/users" do

But generate documentation that looks like this:

image

Maybe in the resource declaration, I could do

resource "Users", prefix: "/api/v1" do

Maybe even then, we could still use the shorthand for the requests?

resource "Users", prefix: "/api/v1" do
  get "/users" do

I'm not sure which makes more sense, or if there's already a way to do something like this.

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