API-Documentation

• API-Documentation
  • HowTo
  • Getting Started with Scramble
  • Using Postman

HowTo

Scramble in Combination of Scalar and Postman

Scramble for Generating documentation and developing https://scramble.dedoc.co/

Scalar for simple online view https://github.com/scalar/scalar

Postman for pushing and living the API https://learning.postman.com/

Getting Started with Scramble

SCRAMBLE_PATH="/scramble"
SCRAMBLE_UI_PATH="${SCRAMBLE_PATH}" # /scramble/docs/v1/
SCRAMBLE_JSON_PATH="${SCRAMBLE_PATH}/openapi.json"

SCALAR_PATH="/scalar"
SCALAR_OPENAPI_URL="${SCRAMBLE_JSON_PATH}"
SCALAR_CDN_URL="https://cdn.jsdelivr.net/npm/@scalar/api-reference"

Using Postman

TeamSite: https://bluesafety.postman.co/

Import OpenAPIv3.json to Postman.