ExampleApi.md

ExampleApi

• ExampleApi

  • POST /api/image
  • GET /api/user
  • POST /api/user
  • PUT /api/users
  • GET /api/users
  • GET /api/users/{integer}

POST /api/image

(multipart/form-data; boundary=b7nKPzJpa0Do+YuCSNnFspJt)

Request body

data:

(application/json)

{
   "image" : 100
}

attachment:

(application/octet-stream)

[application/octet-stream]

Response 200

(application/json)

"multipart/form-data"

GET /api/user

(none/none)

Fetch user

URL Parameters

Name	required	type	default value	description	example value
name	false	string		Just some user name	John

Request body

(none/none)

[none/none]

Response 200

(application/json)

{
   "id" : 1,
   "name" : "Jim"
}

POST /api/user

(application/json)

Fetch user

Request body

{
   "id" : 2,
   "name" : "Hello"
}

Response 200

(application/json)

{
   "id" : 2,
   "name" : "Hello"
}

PUT /api/users

(none/none)

Request body

(none/none)

[none/none]

Response 405

(text/plain; charset=UTF-8)

HTTP method not allowed, supported methods: GET

GET /api/users

(none/none)

URL Parameters

Name	required	type	default value	description	example value
offset		number			0
limit		number			10

Request body

(none/none)

[none/none]

Request headers

Name	required	type	default value	description	example value
Authorization		string			Basic YWRtaW46YWRtaW4=

Response 200

(application/json)

[
   {
      "id" : 1,
      "name" : "John"
   },
   {
      "id" : 2,
      "name" : "Jim"
   },
   {
      "id" : 3,
      "name" : "Jake"
   },
   {
      "id" : 4,
      "name" : "Jacob"
   },
   {
      "id" : 5,
      "name" : "Jane"
   }
]

GET /api/users/{integer}

(none/none)

Request body

(none/none)

[none/none]

Response 200

(application/json)

{
   "id" : 3,
   "name" : "Jake"
}