https://github.com/different-ai/basel

OpenAI spec generator powered by AI
https://github.com/different-ai/basel

Last synced: 30 days ago
JSON representation

OpenAI spec generator powered by AI

• Host: GitHub
• URL: https://github.com/different-ai/basel
• Owner: different-ai
• Created: 2023-09-05T23:49:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-06T00:30:18.000Z (over 1 year ago)
• Last Synced: 2024-08-03T22:24:12.803Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 24.4 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - different-ai/basel - OpenAI spec generator powered by AI (JavaScript)

README

        
# Basel

Basel is a tool designed to help developers avoid writing OpenAPI specifications from scratch. It leverages the power of AI to generate and validate OpenAPI 3.0 schemas for your API endpoints.

Installation

You can install Basel using npm:

`npm i basel-sdk`

## Usage

Here is an example of how to use Basel:

`basel --root ./ --include api --exclude node_modules`

This command will generate an OpenAPI specification for all files in the api directory (excluding any in the node_modules directory), and write the specification to a file named spec.yaml.

Basel can be used in two ways:

1. By using the Basel API, which requires a `BASEL_API_KEY` and optionally a BASEL_API_URL.

2. By using the client-side API, which requires an `ANTHROPIC_API_KEY`.

You can provide either a `BASEL_API_KEY` or an `ANTHROPIC_API_KEY`, but not both.

### Basel API

If you have a `BASEL_API_KEY`, Basel will use the Basel API to generate and validate your OpenAPI specifications. If you also have a `BASEL_API_URL`, Basel will use this URL as the base URL for the Basel API.

### Client-side API

If you have an `ANTHROPIC_API_KEY`, Basel will use the client-side API to generate and validate your OpenAPI specifications.

## Contributing

Contributions are welcome! Please feel free to submit a pull request.

## License

Basel is licensed under the MIT License.