Sharkio

🐳 What is Sharkio

Sharkio is a development tool for api developers. It is a proxy that records all the requests that are sent to your servers. And provides you with a dashboard to analyze all the traffic. Sharkio also provides the ability to repeat requests. Generate types for youre favorite language based on real data.

🗺️ Roadmap

In the roadmap sharkio will support team functions. Also Sharkio will integrate with ChatGPT in order to allow easy use of api. Request automation. Api inconsistency alerting. Integration to Postman. Automatic CLI generation for your api with real data. Request mocking.

🔖 Features

Feature Name	Available
Inspect traffic	✅
Search	✅
Filter	✅
Repeat request	✅
Typescript generator	✅
JSON schema generator	✅
Microservice support	✅
Request mocks	✅
Open api generator
ChatGPT integration
Save requests
Collections
Share requests

🛠️ How to use

npm install -g sharkio@latest
sharkio dashboard start
sharkio admin start
sharkio admin sniffers create --port 5100 --downstreamUrl http://localhost:3000

🚀 Getting started

npm i -g concurrently ts-node

For the backend

cd into traffic-sniffer.
npm install
npm run dev

For the frontend

cd into traffic-dashboard.
npm install
npm run dev

For both:

npm run dev ( in root directory )

Note:

Incase you want a dummy server to test sniffing as shown in visual demonstration of how to use, then run the follwoing command:
npm run demo ( in root directory )