@zykj2024/api-orbit

v1.0.1

Published

9 months ago

API Orbit - 一个强大的 API 管理工具

0High
0Medium
0Low

api proxy mock development testing

API Orbit

一个强大的 API 代理和 Mock 服务工具。

功能特点

支持 HTTP/HTTPS 请求代理
支持 WebSocket 代理
支持请求/响应拦截和修改
支持 Mock 数据管理
支持请求历史记录
支持规则管理
支持实时预览

快速开始

# 使用 npx 运行
npx @zykj2024/api-orbit

# 或者全局安装后运行
npm install -g @zykj2024/api-orbit
api-orbit

配置说明

服务启动后，默认监听以下端口：

代理服务器：3001
Web 界面：3000

使用说明

启动服务后，访问 http://localhost:3000 打开 Web 界面
在 Web 界面中配置代理规则和 Mock 数据
使用配置的代理地址（默认 http://localhost:3001）进行 API 请求

许可证

MIT

技术栈

前端：Next.js + React + TailwindCSS
后端：Koa
语言：TypeScript

开发

# 安装依赖
npm install

# 启动开发服务器（同时启动前端和后端）
npm run dev

开发服务器启动后，可以访问：

前端页面：http://localhost:3000
后端服务：http://localhost:3001

使用方法

启动应用后，访问 http://localhost:3000
左侧面板显示所有转发的请求记录
点击左侧列表项可以在右侧查看请求的详细信息
若要发送代理请求，使用 http://localhost:3000 作为基础 URL，如 http://localhost:3000/posts
若要指定目标域名，请在请求头中添加 x-target-domain 字段，其值为目标域名（例如 https://api.example.com）

使用示例：

// 使用fetch发送请求
fetch('/posts', {
  headers: {
    'x-target-domain': 'https://jsonplaceholder.typicode.com'
  }
})

// 使用axios发送请求
axios.get('/posts', {
  headers: {
    'x-target-domain': 'https://jsonplaceholder.typicode.com'
  }
})

默认情况下，如果没有提供 x-target-domain 头，所有请求都会被转发到 https://jsonplaceholder.typicode.com，可以在 server/index.ts 中修改 DEFAULT_TARGET_API 变量来更改默认目标 API。

Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files

[ ] Create or upload files
[ ] Add files using the command line or push an existing Git repository with the following command:

cd existing_repo
git remote add origin http://gitlab.muchcloud.com/business-project/front-end-project/api-orbit.git
git branch -M main
git push -uf origin main

Integrate with your tools

[ ] Set up project integrations

Collaborate with your team

Test and Deploy

Use the built-in continuous integration in GitLab.

Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.

Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Name

Choose a self-explaining name for your project.

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.