ℹ️ Api Annie is currently still in pre-release mode.
ℹ️ Consider carefully if you are using it with your confidential data.
Api Annie helps your team to co-ordinate easier when developing a product which needs API comunication, by going through the following steps:
- [Define] Define your API structure.
- [Mock] Frontend developer makes their prototype by using the mock server automatically generated by Api Annie.
- [Execute] Backend developer builds the backend services and test it by sending requests through Api Annie
- [Integrate] When both frontend and backend development are finished, let frontend switch communication from Api Annie to your backend server URL.
We recommend using our cloud service, where you can always get access to the latest features.
If you prefer deploying Api Annie in your own machine, run:
git clone git@github.com:apiannie/apiannie.git
cd apiannie
Then create a file named .env, which should contain the following environment variables:
DATABASE_URL="mongodb+srv://USERNAME:PASSWORD@HOST/DATABASE"
SESSION_SECRET="replace-it-by-random-string"
For more info about connection to MongoDB, please refer to this doc from Prisma
Then install dependency packages, and initalize database:
npm install
npx prisma db push
or if you are using yarn
yarn install
yarn prisma db push
Up to now, you have your environment successfully setup, to run Api Annie in dev mode:
npm run dev or yarn dev
To run in release mode:
npm run build
npm start
or if you are using yarn
yarn build
yarn start
- Remix as the primary full stack web framework
- Database ORM with Prisma
- Static Types with TypeScript
- UI components built with Chakra-UI
- Form validation with remix-validated-form and Zod
- Chance.js for random data generate in mock server
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.