https://github.com/llm-studios/swaggerboy

AI-Copilot for OpenAPI Description Documents
https://github.com/llm-studios/swaggerboy

ai aisdk copilot openai openapi-specification openapi3

Last synced: 1 day ago
JSON representation

AI-Copilot for OpenAPI Description Documents

• Host: GitHub
• URL: https://github.com/llm-studios/swaggerboy
• Owner: LLM-Studios
• License: mit
• Created: 2024-11-11T20:49:34.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-09T12:28:56.000Z (about 1 month ago)
• Last Synced: 2025-01-12T18:52:39.379Z (2 days ago)
• Topics: ai, aisdk, copilot, openai, openapi-specification, openapi3
• Language: TypeScript
• Homepage: https://swaggerboy.dev
• Size: 532 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Swaggerboy

An AI-powered copilot for API design and OpenAPI specification generation. Swaggerboy helps to design and document APIs through an interactive, conversation-based approach.

## Quick Start

```typescript

npx swaggerboy

```

## Features

- 🤖 Interactive API design through natural language conversations

- 📝 OpenAPI 3.1.0 specification generation

- 💡 Proactive feature recommendations

## Key Capabilities of Swaggerboy

- Guides users through high-level API design

- Creates detailed schema components and data models

- Establishes reusable components (responses, parameters, examples)

- Validates OpenAPI specifications

- Extends endpoint operations with implementation details

## Built With

- [OpenAPI Specification 3.1.0](https://www.openapis.org/)

- [OpenAI for LLM-based conversational AI](https://github.com/openai)

- [Vercel AI SDK](https://github.com/vercel/ai)

- [Stoplight elements for interactive OpenAPI](https://github.com/stoplightio/elements)

- [Shadcn/ui](https://github.com/shadcn-ui/ui)

- [assistant-ui](https://github.com/Yonom/assistant-ui)

- [Next.js](https://github.com/vercel/next.js)

- [openapi3-ts](https://github.com/metadevpro/openapi3-ts)

https://llmstudios.de/

## License

Swaggerboy is licensed under the MIT License.