Yes you heard it right. One opensource tool for all your API needs. The tool is APIC. You might think that's a bold claim to say APIC is the tool you need for everything API, well lets see how APIC lives up to these claim.
APIC is a free open-source solution that can help you in API Designing, API Testing (even during designing), API Documentation, Simulating your API response for the frontent team etc.
A typical API development cycle involves the following steps.
- API design
- API API development
- API Testing
- API Integration
And APIC can help you with each of these steps. Lets start with API Designing.
If you are in a team that follows the Design first strategy for API development then Your API life-cycle starts with API Designing.
In this step you would first define a contract for your API with Swagger Editor (as this is the widely accepted standard). Unless you don't like writing your API design in a text editor OR you are not familiar with the Swagger Specification.
Enter APIC. With APIC's API Designer, defining your API is as simple as filling a form. The API designer can help you with
Defining your API endpoints, request parameters, request headers and response schema. More here
Defining reusable model definitions.More here
You can also start writing tests for your APIs even during API designing. And the best part is you can do that even without writing a single line of code just from the UI. Know more here.
Create a team and share with everyone.
Now that your API contract is defined your backend team can start the development, but what about the frontend team. Well they can immediately start using the APIs by using the API Simulator provided by APIC. No more waiting.
If you designed your APIs in APIC, they are automatically available for your team to test in the API Tester section. Your developers/testers won't have to import it again to (say Postman) to start testing.
Things you can do with the API tester
- Obviously test your APIs
- Test Web Sockets, Socket.io, STOMP and Server Sent Events (SSE)
- Using Environment variables to switch between environments like local, Dev, QA, Pre-prod etc.
- Response schema validation as per your API design.
- Add tests to your APIs directly from the response or if you want to get more technical use Chai.js to write tests.
- Create Test Projects and Test Suites to test various API scenarios and export test report.
- Add your Test Suites to your CI/CD platform with apic-cli.
- Capture APIs from real user sessions using APIC directly from devtools or export your network requests as HAR files and import into your test suites.
Once your API design is done APIC automatically converts your APIs designs into beautiful functional documentations that will help others to get on board faster. You can even share it with the world by publishing it online with APIC.
And many more exciting features
A few more worth mentioning features are
- Free teams and sharing feature
- Real-time update of changes made to API projects/Tests among team members.
- Importing/Export of everything you have created in APIC.
- No need to install anything. Available as a web app. But also available as Chrome extension, Windows exe and Mac dmg.
And the best part; its free and opensource. To live upto the claim that this is the only tool you will need for all your API needs I have made apic opensource and hoping to get the community excited about this and start contributing.
Sounds interesting? Head over to our Github page to contribute. The current version is developed in angular-js but an angular version is in the works.
Hope you will like what I have done so far. Would love to hear your feedback here.