Fake User
1.0.0

This is a simple workshop combined with a fairly elaborate demonstration of how to approach improving an API to production-grade levels.

This is the documentation for version 1.0.0 of the API. Last update on Dec 13, 2021.

Base URL 
https://RANDOM.execute-api.REGION.amazonaws.com/shared

Returns a fake user

GET /fakeUser

Returns a fake user

Headers

  • Authorization string Required

    User name (email) of the user to authorize

  • X-Client-Version integer(int32) Required

    API client version to use

    Minimum value is 1, maximum value is 2.

Responses

  • • 200

    Successful response

    Hide response attributes Show response attributes object
    • name string

      The fake user's name.

      Minimum length is 4, maximum length is 30. Format should match the following pattern: ^[\w\-\s]{4,30}$.

    • image string

      The fake user's image URL (cat photo).

      Minimum length is 10, maximum length is 100. Format should match the following pattern: /[\w\-\.\/:]*$/.

    • id string

      The fake user' ID.

      Minimum length is 8, maximum length is 40. Format should match the following pattern: /[\w\-]*$/.

    • email string

      The fake user's fake email address.

      Minimum length is 4, maximum length is 30. Format should match the following pattern: ^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$.

    • Additional properties are NOT allowed
  • • 403

    Forbidden

    Minimum length is 3, maximum length is 30. Format should match the following pattern: ^[A-Za-z0-9.!\s]{3,30}$.
  • • default

    Unauthorized

    Minimum length is 3, maximum length is 30. Format should match the following pattern: ^[A-Za-z0-9.!\s]{3,30}$.
  • • 401

    Unauthorized

    Minimum length is 3, maximum length is 30. Format should match the following pattern: ^[A-Za-z0-9.!\s]{3,30}$.
  • • 404

    Not found

    Minimum length is 3, maximum length is 30. Format should match the following pattern: ^[A-Za-z0-9.!\s]{3,30}$.
  • • 406

    Not acceptable

    Minimum length is 3, maximum length is 30. Format should match the following pattern: ^[A-Za-z0-9.!\s]{3,30}$.
  • • 429

    Too many requests

    Minimum length is 3, maximum length is 30. Format should match the following pattern: ^[A-Za-z0-9.!\s]{3,30}$.
GET /fakeUser 
curl \
 -X GET https://RANDOM.execute-api.REGION.amazonaws.com/shared/fakeUser \
 -H "Authorization: string" \
 -H "X-Client-Version: 42"
Response examples (200) 
{
  "name": "string",
  "image": "string",
  "id": "string",
  "email": "string"
}
Response examples (403) 
"Forbidden"
Response examples (default) 
"Unauthorized"
Response examples (401) 
"Unauthorized"
Response examples (404) 
"Not found"
Response examples (406) 
"Not acceptable"
Response examples (429) 
"Too many requests"