Giter VIP home page Giter VIP logo

apiexpress's Introduction

👾 APIExpress

Screenshot of apiexpress UI

API Express was created to solve a common problem with Agency work. Starting native development before API’s are ready.

Using Mock data in native applications and acquiring test data is not always as straight-forward as you'd think. A developer may sit idle for days sometimes waiting for this. Using APIExpress and with a simple request,APIExpress can generate the data matching your prompts and schema.

AI Usage in this project

  • ChatGPT3 API.
  • Gamma.app for the deck.
  • Notion AskAI and ChatGPT for generating documents and brainstorming ideas.
  • AI for generating logo.
  • ChatGPT for generating some javascript functions.

Current Features

  • Generate responses to any API request ~10 objects at a time is performant. This could be easily enhanced with a more capable GPT mode.
  • Requests are hashed and responses cached. subsequent calls are much faster.
  • Ability to bypass cache.
  • Basic UI for testing requests.
  • Simple nested structures.
  • Robust and verbose logging.

Future Enhancements

  • Generate API Documentation.
  • Database integration to near-instantly populating test data once API’s are built, but before there is data.
  • Generate model objects and request code for the API’s in Swift, Kotlin, C# or other native languages.
  • Improved JSON verification and linting.
  • Improved HTTP error code handling.
  • Data consistency between requests.
  • Complex nesting.
  • Pagination of longer data requirements.
  • More complex querying for referenced JSON structures.

Dev setup

Dependencies

Branching

  • branch main contains working build

Local installation

  1. Clone repository & cd into the ultimock directory
  2. Duplicate .env.example as .env and add your OpenAI_API_KEY
  3. yarn to install package dependencies
  4. yarn build to build the app
  5. yarn docker:build to build your docker image
  6. yarn docker:run to bind your docker image to https://localhost:8080 and serve
  7. Using the web interface concatenate your query
  8. Logs and caches are archived to your filesystem under app/storage/logs and app/storage/cache respectively

Postman collection

A Postman collection of test queries can be found in the repository as well titled postman_collection.json

apiexpress's People

Contributors

dustinnewboldyml avatar westonhanners avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.