postcat/wiki/README.en.md
2022-11-12 21:58:55 +08:00

3.6 KiB

A extensible API tool,Easy & Open Source API Ecosystem

License Version Downloads Chat

English | 简体中文

Eoapi (pronounced: E-O-API)

Try it!

https://eoapi.io

The data will be stored locally(indexedb) on the web page.I suggest that you should install and try it out for the best demo experience.

Getting started

Featue

📃 API Documentation

  • HTTP,Websocket protocol
  • Various formats of request body: FormData, XML, JSON, Raw,Binary

API Test

  • Quickly test the API
  • Test local API

🎭 Mock

  • Mock API document response

🌐 Test environment management

📶 Available offline

🌱 Extension Marketplace

💻 Collaboration

🌐 Internationalization

Build and run

Prerequisites

  • Node.js >= 14.17.x
  • yarn >= 1.22.x

Running the code

We use yarn as a package management tool for development and building, and it is highly recommended that you do the same, but if you want to use npm it's perfectly fine, it just might take a little more time to install dependencies.

yarn install
yarn start

If you want to improve Angular development efficiency, you can install the command-line Angular-cli officially provided by Angular to quickly generate templates such as components and services.

yarn add @angular/cli --global

Command

Run

Command Description
yarn start In development mode, running on browser and desktop at the same time
yarn serve:web only runs in the web
yarn electron:serve only runs in the desktop

Build

Command Description
yarn build Packaging Electron applications for each platform

Running the tests

Command Description
yarn test Execute unit tests

License

This project is licensed under the Apache-2.0 License - see the LICENSE.md file for details

Contact us

If you'd like to contact us, please create a Github issue. Thank you!