contracts

All hungover contracts such as openapi, asyncapi or data product specifications

• Current Site
• Static Web App

Structure

project
│   README.md
│
└───domain01
│   │   README.md
│   │   Requirements
│   │   DomainModel
│   └───api
│       │   domain01.oas.0.1.yml
│       │   domain01_oas_0_1.html
│       │   ...
│   └───events
│       │   domain01.asyncapi.0.1.yml
│       │   domain01_asyncapi_0_1.html
│       │   ...
│   └───dataproduct
│       │   domain01.datacontract.0.1.yml
│       │   domain01.datacontract.0.1.html
│       │   ...
│
└───domain02
│   │   README.md
│   │   Requirements
│   │   DomainModel
│   └───api
│       │   domain02.oas.0.1.yml
│       │   domain02_oas_0_1.html
│       │   ...
│   └───events
│       │   domain02.asyncapi.0.1.yml
│       │   domain02_asyncapi_0_1.html
│       │   ...
│   └───dataproduct
│       │   domain02.datacontract.0.1.yml
│       │   domain02.datacontract.0.1.html
│       │   ...
│

Containerize Docs

• Containerize Docs
• Static Web App deploy

Useful Links

• REST Origin - Roy Fielding

• Open API

  • Open API Lifecycle
  • Open API Generator

• Redoc

• Open API Fundamentals Course

  • Open API Fundamentals Course Github
  • Semantic Versioning
  • Doc Ops
  • Zuora Dev Example API Spec
  • Kiota - Generate Client
    • Kiota Quick Starts
  • Spectral - Open API linting and governance.
    • Spectral Setup Example
    • Spectral Real-World Rulesets

• Open API Docusaurus - Best Tool

  • Open API Docusaurus - Other Examples
  • Docusaurus Resources
  • Good Fuse Github
  • Good Fuse Example
  • Open API Showcase

• Open API Idea to Implementation

• Swagger VS Code

• Swagger Code Gen

• Swagger Hub

• Prism Mock API

• Specmatic

• API Blueprint

• Design APIs with Swagger and Open API

• Arazzo - Sequence of API Calls

• pact

• Async API

  • Async API VS Code
  • Async API Online Editor

• Data Contract

  • Data Contract CLI
  • Data Contract GPT

• Open Data Product Specification

• Data Contracts: Creating APIs for Your Data

• Drivng Data Quality with Data Contracts

• Bitol

• soda

• great expectations

• data contract online editor

• data contract gpt

• data contract json schema

• APIs and Data Closer Together

• Adidas API guidelines

Dictionary

• HTTP - Hypertext Transfer Protocol
• REST - Representational State Transfer
• URI - Uniform Resource Identifier

Status Codes

• 1xx Informational
• 2xx Success
• 3xx Redirection
• 4xx Client Error
• 5xx Server Error

Open API

openapi: 3.0.0
security:
  - mySecurityRule: [ ]
info:
  title: Sample API
  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
  version: 0.1.0
servers:
  - url: http://api.example.com/v1
    description: Optional server description, e.g. Main (production) server
  - url: http://staging-api.example.com
    description: Optional server description, e.g. Internal staging server for testing
paths: ## Paths Object
  /users: ## Path Item Object has GET, POST etc
    get: ## Operation Object has a summary description etc
      summary: Returns a list of users.
      description: Optional extended description in CommonMark or HTML.
      responses:  ## Responses Object as 200, 404 etc
        '200': ## Response Object has description, content etc
          description: A JSON array of user names
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
components:
  securitySchemes:
    mySecurityRule:
      type: http
      scheme: bearer