Skip to content

Instantly share code, notes, and snippets.

@kinlane
Created January 30, 2021 04:40
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/bb86a80caa06d4a66daa5db9afd0fdd6 to your computer and use it in GitHub Desktop.
Save kinlane/bb86a80caa06d4a66daa5db9afd0fdd6 to your computer and use it in GitHub Desktop.
API Landscape APIs.json
{
"name": "API Landscape",
"x-slug": "api-landscape",
"description": "This is a generic machine readable definition that can be used to define an entire, or specific portion of API operations, from the view of the provider, consumer, vendor, analyst, or regulatory entity.",
"image": "https://s3.amazonaws.com/kinlane-productions2/api-evangelist-logos/api-evangelist-red-seal.png",
"tags": [
"API",
"Landscape"
],
"created": "2021-01-23",
"modified": "2021-01-23",
"url": "http://example.com/apis.yaml",
"specificationVersion": "0.14",
"apis": [
{
"name": "Web API",
"x-api-slug": "web-api",
"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-postman-documentation-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-postman-mock-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-postman-availability-test-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-postman-contract-test-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-postman-performance-test-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-postman-security-test-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-postman-governance-test-collection",
"url": "https://www.getpostman.com/collections/{collection_id}"
},
{
"type": "x-github-repo",
"url": "https://github.com/{org}/{repo}"
},
{
"type": "x-postman-workspace",
"url": "https://www.postman.com/{team}/workspace/{workspace}"
},
{
"type": "x-backend-code",
"url": "https://example.com/backend-code/"
},
{
"type": "x-pre-request-script",
"url": "https://example.com/pre-request-script/"
},
{
"type": "x-post-request-script",
"url": "https://example.com/post-request-script/"
},
{
"type": "x-client-code",
"url": "https://example.com/client-code/"
},
{
"type": "x-openapi-workflow",
"url": "https://example.com/workflow.yaml"
}
]
},
{
"name": "Real Time API",
"x-api-slug": "real-time-api",
"description": "This is a websockets API.",
"image": "https://s3.amazonaws.com/kinlane-productions2/api-evangelist-logos/api-evangelist-red-seal.png",
"humanURL": "https://ws.api.example.com",
"tags": [
"API",
"Landscape",
"Web"
],
"properties": [
{
"type": "x-asyncapi",
"url": "https://example.com/asyncapi.yaml"
},
{
"type": "x-json-schema",
"url": "https://example.com/json-schema.yaml"
},
{
"type": "x-github-repo",
"url": "https://github.com/{org}/{repo}"
},
{
"type": "x-client-code",
"url": "https://example.com/client-code/"
}
]
}
],
"x-common": [
{
"type": "x-website",
"url": "https://example.com"
},
{
"type": "x-developer",
"url": "https://developer.example.com/"
},
{
"type": "x-about",
"url": "https://example.com/about/"
},
{
"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-dashboard",
"url": "https://example.com/dashboard/"
},
{
"type": "x-cli",
"url": "https://example.com/cli/"
},
{
"type": "x-open-source",
"url": "https://example.com/open-source/"
},
{
"type": "x-github-org",
"url": "https://example.com/github/"
},
{
"type": "x-webhooks",
"url": "https://example.com/webhooks/"
},
{
"type": "x-applications",
"url": "https://example.com/applications/"
},
{
"type": "x-integrations",
"url": "https://example.com/integrations/"
},
{
"type": "x-versioning",
"url": "https://example.com/versioning/"
},
{
"type": "x-road-map",
"url": "https://example.com/road-map/"
},
{
"type": "x-change-log",
"url": "https://example.com/x-change-log/"
},
{
"type": "x-availability-test-results",
"url": "https://example.com/availability-test-results/"
},
{
"type": "x-contract-test-results",
"url": "https://example.com/contract-test-results/"
},
{
"type": "x-performance-test-results",
"url": "https://example.com/performance-test-results/"
},
{
"type": "x-security-test-results",
"url": "https://example.com/security-test-results/"
},
{
"type": "x-governance-test-results",
"url": "https://example.com/governance-test-results/"
},
{
"type": "x-newsletter",
"url": "https://example.com/newsletter/"
},
{
"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-linkedin",
"url": "https://example.com/linkedin/"
},
{
"type": "x-youtube",
"url": "https://example.com/youtube/"
},
{
"type": "x-press",
"url": "https://example.com/press/"
},
{
"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-tickets",
"url": "https://example.com/tickets/"
},
{
"type": "x-issues",
"url": "https://example.com/issues/"
},
{
"type": "x-stack-overflow",
"url": "https://example.com/stack-overflow/"
},
{
"type": "x-forum",
"url": "https://example.com/forum/"
},
{
"type": "x-status",
"url": "https://example.com/status/"
},
{
"type": "x-case-studies",
"url": "https://example.com/case-studies/"
},
{
"type": "x-tutorials",
"url": "https://example.com/tutorials/"
},
{
"type": "x-webinars",
"url": "https://example.com/webinars/"
},
{
"type": "x-streams",
"url": "https://example.com/streams/"
},
{
"type": "x-videos",
"url": "https://example.com/videos/"
},
{
"type": "x-podcasts",
"url": "https://example.com/podcasts/"
},
{
"type": "x-terms-of-service",
"url": "https://example.com/terms-of-service/"
},
{
"type": "x-privacy-policy",
"url": "https://example.com/privacy-policy/"
},
{
"type": "x-licensing",
"url": "https://example.com/licensing/"
},
{
"type": "x-service-level-agreements",
"url": "https://example.com/service-level-agreements/"
},
{
"type": "x-security-policy",
"url": "https://example.com/security-policy/"
},
{
"type": "x-provenance",
"url": "https://example.com/provenance/"
},
{
"type": "x-transparency",
"url": "https://example.com/transparency/"
},
{
"type": "x-compliance",
"url": "https://example.com/compliance/"
},
{
"type": "x-certification",
"url": "https://example.com/certification/"
}
],
"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