Idea of the project

[AlexS778]

This project is going to be an aggregation of API for all sites. Users can search through to find relevant servers, and perform live calls.

Real case:
I want to search open API definition and start executing requests (I may only want to go through endpoints and decide is that API fit my goals)

So that I don’t need to lookup for API definition on required web site and copy them to local app.

How it's going to work:

• I’m getting to the API Hub website

• I’m entering required website name to search area.

• I’m selecting website from search results and move to API view.

• Finally I can view and execute requests to web site API (postman like)

If requested web site not found I can add new API definition by providing link to open API file (swagger file). And execute requests to API.

How project is going to look:

4 services:

1. Data scraping service - it's going to parse swagger files to API definition.
2. Storage and update service - Basically CRUD, it's going to store and update scraped API definition here.
3. API Gateway - it's going to interact with UI, route requests.
4. UI - It's going to interact with API Gateway, view and perform client side requests to API.

You can see more detailed explanation on this diagram:
https://app.terrastruct.com/diagrams/1204758278
https://app.terrastruct.com/diagrams/1204758278