https://github.com/opticdev/optic

OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.
https://github.com/opticdev/optic

api-documentation api-linter apis documentation openapi openapi3 swagger

Last synced: 6 days ago
JSON representation

OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.

• Host: GitHub
• URL: https://github.com/opticdev/optic
• Owner: opticdev
• License: mit
• Created: 2018-03-02T17:02:50.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-25T14:38:38.000Z (6 months ago)
• Last Synced: 2024-10-29T14:54:29.891Z (6 months ago)
• Topics: api-documentation, api-linter, apis, documentation, openapi, openapi3, swagger
• Language: TypeScript
• Homepage: https://useoptic.com
• Size: 206 MB
• Stars: 1,356
• Watchers: 11
• Forks: 83
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-rest - Optic - Maintain an accurate API specification without writing OpenAPI/Swagger. Works with any Stack (Documentation / Public REST APIs To Use In Tests)
• awesome-api-security - Optic - to-date | (Tools)
• jimsghstars - opticdev/optic - OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs. (TypeScript)

README

        
 

![GitHub Repo stars](https://img.shields.io/github/stars/opticdev/optic?style=social) ![GitHub contributors](https://img.shields.io/github/contributors-anon/opticdev/optic?style=social) ![npm](https://img.shields.io/npm/dm/@useoptic/openapi-io?style=social) ![license](https://img.shields.io/github/license/opticdev/optic?style=social)

# Optic - OpenAPI made easy

🧠 **Generate OpenAPI** from test traffic

⚡️ **Keep OpenAPI spec accurate** with automatic schema testing and patches

🤩 **Catch Breaking Changes and apply Lint Rules** with the same tool

> Optic supports $ref and OpenAPI specs split across multiple files. It always 

## [Read Documentation](https://github.com/opticdev/optic/wiki) 

### Demos

https://github.com/user-attachments/assets/b386bb42-39a5-4db0-aea5-c2399588ebb0

https://github.com/user-attachments/assets/bb6af098-6e91-4636-b88c-1c9bc586cce0

https://github.com/user-attachments/assets/1b07bfd9-364c-4bbe-baeb-493bed392cdf

### Install

```bash

npm install -g @useoptic/optic

```

## ⏭️ [Get Started!](https://github.com/opticdev/optic/wiki) 

### License

Optic is MIT Licensed 

[Optic Labs is now part of Atlassian](https://www.atlassian.com/blog/announcements/optic-acquisition)