Authentication

[zdne]

Direct support for API authentication.

RFC proposals

• API Blueprint RFC 0002: Authentication Framework
• API Blueprint RFC 0003: Basic Authentication Scheme
• PR: OAuth 2 Authentication Scheme

[xurde]

This sounds really useful to me.

[zdne]

@xurde Glad to hear that! If you feel like, feel free to propose a syntax or just share a stub / example of how would you like to describe it. Also are you interested in a particular type of authentication?

[rurounijones]

I would be interested in supporting OAuth 1.1 which requires setting HTTP Authorization header with various fields.

[remkoboschker]

I would like to be able to mock / use / define the requesting of a token based on username/credentials and using that token for subsequent requests to the api. I suppose inlining some javascript that generates / parses the tokens or the username/credenitials into the blueprint could be a solution.

[kadishmal]

OAuth 2.0 is quite widely used.

[zdne]

Please let me know whether traits as proposed in #47 would improve auth needs. Also refer to this example: https://gist.github.com/zdne/01e287fe18d232672d43#file-4-example-gist-fox-api-md

[zdne]

To be addressed (and closed) with #47.

[w3irdrobot]

Not sure if this is still being worked on, but a way to document that an API key is required for all requests would be great! So somewhere I could put that {?apikey} is in all requests without having to manually add it as parameters to all paths.

[zdne]

Hey @searsaw,
yes, this is our top-priority – scheduled right after #25 (which is drawing to an end so we will hopefully start on it soon).

cc @pksunkara

[netmilk]

The oauthd project has a very nice gallery of declarative descriptions for various OAuth authentications of more than 100+ production APIs. Have a look to files conf.json and settings.json in any folder here.

I think it's a good inspiration for OAuth requirements in the API Blueprint syntax.

[pksunkara]

Syntax proposed at #201

[zdne]

Added RFC proposals to the OP: #11 (comment)

[imanel]

So what's the status of authentication? #201 was closed, because it was superseded by apiaryio/api-blueprint-rfcs#5 and apiaryio/api-blueprint-rfcs#6. They were merged as RFC over two years ago, so is it going to be implemented?

[hsluoyz]

Any update?