Skip to content

Release 0.1.0 - Ask OpenAPI

Latest
Latest
Compare
Choose a tag to compare
@dm1tryG dm1tryG released this 20 Sep 18:15
· 2 commits to master since this release
v0.1.0
489a8e5
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

Overview

The initial release of Ask OpenAPI introduces a web application designed to facilitate interaction with OpenAPI specifications. Users can convert complex OpenAPI JSON specs into structured, human-readable formats through an intuitive chat interface.

Features

  • Interactive Chat Interface: Users can ask questions about OpenAPI specifications and receive formatted responses.
  • OpenAPI Specification Retrieval: Fetch OpenAPI specs from a provided URL and sync them for processing.
  • Human-Readable Formatting: Convert OpenAPI specs into neatly structured text, including summaries, descriptions, tags, responses, parameters, and curl examples.
  • Docker Support: Easily deploy the application using Docker and Docker Compose.

Installation

  • Users can set up the application by cloning the repository, creating a .env file based on example.env, and running the application using Make commands.

Commands

  • make sync url=<your_openapi_url>: Sync OpenAPI specifications from a specified URL.
  • make chat: Start the chat interface for user interaction.
  • make clean: Clean up generated data.

Configuration

  • The application requires an OpenAI API Key, which must be set in the .env file. Default models for embeddings and chat are provided.
Assets 2
Loading