Skip to content

Instantly share code, notes, and snippets.

@kinlane
Created November 14, 2024 22:31
Show Gist options
  • Save kinlane/f544cf56f703aea25e1c843bf5d6a535 to your computer and use it in GitHub Desktop.
Save kinlane/f544cf56f703aea25e1c843bf5d6a535 to your computer and use it in GitHub Desktop.
Add API Test
aid: test-add-1
name: Testing Adding API
type: Contract
description: |-
This is a contract APIs.json, providing a boilerplate contract that an API consumer, or potential API consumer can use to express what is expected when one company provides an API to another company.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
tags:
- Application Programming Interface
- API
- Contract
created: '2024-07-09'
modified: '2024-07-09'
url: http://example.com/apis.json
specificationVersion: '0.18'
apis:
- aid: api-json-contract:api
name: API Contract
description: These are properties that are expected for any API being made available, defining the baseline contract between API producer and consumer.
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
humanURL: http://example.com
baseURL: http://api.example.com
tags:
- API
- Application Programming Interface
- Contract
properties:
- type: Documentation
url: http://example.com
- type: OpenAPI
url: properties/openapi.yml
contact:
- FN: Support
email: [email protected]
common:
- type: Authentication
url: http://example.com/authentication
- type: GettingStarted
url: http://example.com/getting-started
- type: Support
url: http://example.com/support
- type: Pricing
url: http://example.com/pricing
- type: StatusPage
url: http://example.com/status-page
- type: ChangeLog
url: http://example.com/change-log
maintainers:
- FN: API Commons
email: [email protected]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment