Skip to main content

Fences is an LLM augmented OpenAPI interpreter with a visual interface to easily make requests

Project description

Fences

Package version

An LLM augmented OpenAPI specification interpreter that provides a human-readable interactive representation of APIs, automatically generate requests and stores both requests and responses on your browser to improve AI-generated requests in future queries.

Fences operates similarly to SwaggerUI, but with a more human-friendly interface. It uses AI to create a visual diagram and categorize endpoints. After the initial parse Fences uses the OpenAPI specification to automatically generate request bodys for you, filling with it with sample data. It stores every single request and response data in your browser to better generate future requests. Data is only stored locally, the only third-party server it uses is Anthropic's API to access LLMs.

alt text

Work in progress

Fences is still under construction and may break for some edge cases. Please submit an issue with a reproducible example if you encounter any problems.

Usage

pip install fences-api # Installation command
fences # You will be prompted for an anthropic api key and for the link to the openapi spec

You will be prompted to enter your anthropic key so that fences can make requests to an LLM model to parse the OpenAPI specification.

How to contribute

PR's are welcome!

Please create an issue before opening a PR so that we can discuss the changes you want to make.

How to setup your dev enviroment

pip install -r requirements.txt
cd ui && npm install && npm run build && cd..
python fences/cli.py
pip install -e . # To test package locally

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fences_api-0.1.3.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fences_api-0.1.3-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file fences_api-0.1.3.tar.gz.

File metadata

  • Download URL: fences_api-0.1.3.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.18.2 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for fences_api-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0b54c48001b83ca7c29f9913eb79bce076765e634dafe7901df850c69d2c1670
MD5 337f4c25855df89792dfb636a03c9bee
BLAKE2b-256 277908d1a744d7f1e9bfe0a94d2997da63e6e007f76762d10d5c3a5bcc8b7630

See more details on using hashes here.

File details

Details for the file fences_api-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: fences_api-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.18.2 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for fences_api-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 944175743637c89cbda0413792e97533e06b494596c41283b4ae3dbaf3e9f8bb
MD5 979377c040af0345dc50c7f43ce162a8
BLAKE2b-256 8255a3f1a5ff47247db524a93f25eafbfbebcf20b0b80ad72c88a68e498b7502

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page