Skip to content
forked from Oferlis/sharkio

Sharkio is an API proxy for you development environments. It records all the requests that are sent to your API. It allows you to replay the requests easily. Generate types, documentation, test suites, And interact with your API using AI.

License

Notifications You must be signed in to change notification settings

shravan20/sharkio

 
 

Repository files navigation

logo

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.

Help us help you!

🗺️ 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
Save requests
Collections
ChatGPT integration
Share requests

🛠 Tech Stack

🛠️ How to use

  1. Log in to https://sharkio.dev
  2. Setup your proxy (local server with ngrok or alternative)
  3. Change the configuration of the project to use https://<generated_subdomain>.sniffer.sharkio.dev
  4. Use Sharkio 🎉

🚀 Getting started

Running in development

  • npm i -g concurrently ts-node

For the backend

cd into server.

npm install

npm run dev

For the frontend

cd into client.

npm install

npm run dev

For both:

npm run dev ( in root directory )

Note:

Running in production - using Docker

Run whole project:

  • in root of project, use:
  • docker-compose up
  • NOTE: use ports 5550-5560 as proxies, make sure they are available.

Run backend/frontend only:

  • cd to relevent folder
  • build the Docker image: npm run docker:build
  • run the app: npm run docker:run

❓ Setup FAQs:

[1] Pre-commit hook is not installed during normal installation, what should I do? To setup husky [pre-commit hook] manually by running this command: `npm run prepare`
[2] What does `traffic-dashboard` and `traffic-snifer` directory contain? `traffic-dashboard` is the frontend code || `traffic-snifer` is the backend code

⚡ Social links

👩🏻‍💻 Want to contribute?

  • Fork the repo, clone it to your local environment and start exploring the code.
  • Look for an issue, preferably from the next milestone list.
  • Ask to be assigned to the issue.
  • Got stuck? need an advice? find us in the Discord server.
  • Found a bug? 🐛 please open an issue.

🤝 Acknowledgement

🏆 Contributors

Appreciating all our fellow contributors:

About

Sharkio is an API proxy for you development environments. It records all the requests that are sent to your API. It allows you to replay the requests easily. Generate types, documentation, test suites, And interact with your API using AI.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 78.2%
  • JavaScript 11.4%
  • HTML 5.1%
  • CSS 4.5%
  • SCSS 0.7%
  • Dockerfile 0.1%