Design spike for embedded/importing/referencing Swagger/Markdown/WIKI/Pages

[ikethecoder]

Investigate ways that we might create more uniformity with external guides for APIs.

Existing guides that clients (and our own) have created:

• https://api.gov.bc.ca/ds/api/v2/console/
• https://bcgov.github.io/aps-infra-platform/
• https://github.com/bcgov/moh-hnclient-v2/wiki/HNS-Client-User-Journey
• https://bcgov.github.io/common-service-showcase/services/cdogs.html
• https://bcgov.github.io/common-service-showcase/services/ches.html
• https://bcgov.github.io/common-service-showcase/onboarding/aps.html

Documentation elements that we should consider standardizing:

• API Endpoints
• OpenAPI spec links and viewer
• "Try It" console (i.e./ Swagger Console)
• Table of Contents for a Developer Guide
• Authentication / Authorization
• Onboarding Steps

[ikethecoder]

Examples:

• https://apistore.nrs.gov.bc.ca/store/apis/info?name=ccsc-api&version=v2&provider=admin#tab0
• https://api.gov.au/assets/APIs/api-example.html
• https://medium.com/ontariodigital/ontarios-new-api-guidelines-how-to-create-the-building-blocks-of-government-on-the-internet-d772c6101ced