Skip to content

Instantly share code, notes, and snippets.

@kinlane
Last active January 30, 2021 04:39
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kinlane/e62d3c1d7f4dec68bb0c5b2567043b2d to your computer and use it in GitHub Desktop.
Save kinlane/e62d3c1d7f4dec68bb0c5b2567043b2d to your computer and use it in GitHub Desktop.
minimum-viable-apis-yaml
name: Minimum Viable APIs.json
x-slug: minimum-viable-apis-yaml
description: This is a generic machine readable definition that can be used as a minimum viable APIs.yaml index.
image: https://s3.amazonaws.com/kinlane-productions2/api-evangelist-logos/api-evangelist-red-seal.png
tags:
- API
- MVP
created: "2021-01-29"
modified: "2021-01-29"
url: http://example.com/apis.yaml
specificationVersion: "0.14"
apis:
- name: Web API One
x-api-slug: web-api-one
description: This is a simple web API.
image: https://s3.amazonaws.com/kinlane-productions2/api-evangelist-logos/api-evangelist-red-seal.png
humanURL: https://example.com
baseURL: https://api.example.com
tags:
- API
- Landscape
- Web
properties:
- type: x-openapi-spec
url: https://example.com/openapi.yaml
- type: x-json-schema
url: https://example.com/json-schema.yaml
- type: x-github-repo
url: https://github.com/{org}/{repo}
- type: x-postman-workspace
url: https://www.postman.com/{team}/workspace/{workspace}
- name: Web API Two
x-api-slug: web-api-two
description: This is a simple web API.
image: https://s3.amazonaws.com/kinlane-productions2/api-evangelist-logos/api-evangelist-red-seal.png
humanURL: https://example.com
baseURL: https://api.example.com
tags:
- API
- Landscape
- Web
properties:
- type: x-openapi-spec
url: https://example.com/openapi.yaml
- type: x-json-schema
url: https://example.com/json-schema.yaml
- type: x-github-repo
url: https://github.com/{org}/{repo}
- type: x-postman-workspace
url: https://www.postman.com/{team}/workspace/{workspace}
x-common:
- type: x-website
url: https://example.com
- type: x-developer
url: https://developer.example.com/
- type: x-getting-started
url: https://example.com/getting-started/
- type: x-authentication
url: https://example.com/authentication/
- type: x-documentation
url: https://example.com/documentation/
- type: x-plans
url: https://example.com/plans/
- type: x-signup
url: https://example.com/signup/
- type: x-login
url: https://example.com/login/
- type: x-sdks
url: https://example.com/sdks/
- type: x-road-map
url: https://example.com/road-map/
- type: x-change-log
url: https://example.com/x-change-log/
- type: x-blog
url: https://example.com/blog/
- type: x-blog-rss
url: https://example.com/blog/rss/
- type: x-twitter
url: https://example.com/twitter/
- type: x-faq
url: https://example.com/faq/
- type: x-email
url: https://example.com/email/
- type: x-contact-form
url: https://example.com/contact-form/
- type: x-status
url: https://example.com/status/
- type: x-terms-of-service
url: https://example.com/terms-of-service/
- type: x-privacy-policy
url: https://example.com/privacy-policy/
maintainers:
- FN: Kin Lane
x-twitter: apievangelist
email: info@apievangelist.com
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment