https://github.com/future-architect/apidoor
apidoor is a framework that can be used to build a WebAPI platform
https://github.com/future-architect/apidoor
Last synced: 8 months ago
JSON representation
apidoor is a framework that can be used to build a WebAPI platform
- Host: GitHub
- URL: https://github.com/future-architect/apidoor
- Owner: future-architect
- License: apache-2.0
- Created: 2021-08-27T10:36:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-28T10:11:43.000Z (almost 4 years ago)
- Last Synced: 2025-05-07T21:08:41.392Z (8 months ago)
- Language: Go
- Size: 833 KB
- Stars: 3
- Watchers: 12
- Forks: 2
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# apidoor
apidoor is an OSS product that accelerates the construction of the API market.
[日本語](README_ja.md)
**🚧This project is Work in Progress🚧**
## What is apidoor for
You can use apidoor when
* you want to open APIs for many users and have trouble to publish a list of API and an access token.
## Features
* [x] Routing and access management of WebAPI
* [ ] Auto publish of an API access token
* [ ] Management of products
* [ ] Check the usage situation of APIs
## Getting Started
Prerequisites:
- docker v20.10^
- docker-compose v1.29^
Flow：
```bash
# Clone me
git clone https://github.com/future-architect/apidoor.git
cd apidoor
# Build all services
docker compose build \
--build-arg http_proxy=${YOUR_PROXY} \
--build-arg https_proxy=${YOUR_PROXY} \
--build-arg proxy=${YOUR_PROXY} \
--build-arg https-proxy=${YOUR_PROXY}
# Launch apidoor services
docker compose up -d
# Set your first API routing through management-api, and check apidoor works
# Case 1: original api
curl -X POST -H "Content-Type: application/json" \
-d '{"api_key": "key", "path": "test", "forward_url": "http://test-server:3333/welcome"}' localhost:3001/mgmt/routing
curl -H "Content-Type: application/json" -H "X-Apidoor-Authorization:key" localhost:3000/test
# welcome to apidoor!
# Case 2: external api using https scheme with query parameter
curl -X POST -H "Content-Type: application/json" \
-d '{"api_key": "key", "path": "github/search", "forward_url": "https://api.github.com/search/repositories"}'\
localhost:3001/mgmt/routing
curl -H "Content-Type: application/json" -H "X-Apidoor-Authorization:key" localhost:3000/github/search?q=apidoor
#
# Case 3: external api with access token
# You must generate your GitHub's access token allowing to access repo:status in advance
curl -X POST -H "Content-Type: application/json" \
-d '{"api_key": "key", "path": "github/user/repos", "forward_url": "https://api.github.com/user/repos"}' \
localhost:3001/mgmt/routing
curl -H "Content-Type: application/json" -H "X-Apidoor-Authorization:key" \
-H "Authorization: token " localhost:3000/github/user/repos
#
# Check log file is provided
cat ./log/log.csv
# You can also access Management Console
localhost:8080
```
## Architecture
TODO
# License
Apache 2