API Docs

I use LaRecipe sometimes to write docs for our products/services and share the access with our developers. Here is an example of writing API docs in a nice human-readable way.

حُدّث منذ يومقراءة دقيقة واحدة

Here you may add extra information about the section.

Endpoint

Method	URI	Headers
POST	`/oauth/token`	Default

URL Params

text

None

Data Params

json

{
    "grant_type"    : "password",
    "client_id"     : "2",
    "client_secret" : "{client_secret}",
    "username"      : "string|email",
    "password"      : "string",
    "scope"         : "*"
}

For the dev server the

php

$client_secret = dev_client_secret_here

For the production server the

php

$client_secret = production_client_secret_here

json

{
    "grant_type"    : "password",
    "client_id"     : "2",
    "client_secret" : "dev_client_secret_here",
    "username"      : "test@test.com",
    "password"      : "secret",
    "scope"         : "*"
}

Code 200

Content

json

{
  "token_type"    : "Bearer",
  "expires_in"    : "integer",
  "access_token"  : "string|token",
  "refresh_token" : "string|token"
}

Code 422

Reason put description here

Content

json

...

API Docs

Login

Endpoint

URL Params

Data Params