Need API Help

• postman-app-support

  279 5,742 2.3

  Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.

  

If you're trying to learn how to use a specific API, I recommend tinkering with something like Postman first. Don't even worry about the code, just try to learn how the company's API works, and what sorts of functionality is available. Once you're ready, you can convert from Postman to your own code, and the app will even give you some code snippets.

• dredd

  15 4,129 2.4 JavaScript

  Language-agnostic HTTP API Testing Tool

  

Another tip: don't write manual tests for the API. Write tests for the controller/business layer. To test the API, use something like Dredd, which automatically runs a whole suite of tests against your API for free. The only thing you'll need is the API specification in JSON or YAML. Dredd can be a bit confusing at the beginning, so I wrote a blog post about how to use it. The reason I recommend Dredd over your own tests is because unless you have expert knowledge of APIs and HTTP, you'll likely miss something in your tests.

• SurveyJS

  surveyjs.io featured

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• prism

  25 4,024 8.3 TypeScript

  Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations. (by stoplightio)

  

If you have an API, chances are other teams within your organisation are building clients that consume that API. Make sure those clients are built and tested against the API specification. For that, you'll find it useful to run a mock server against the spec. You can use different tools for that, like prism or microapis.io. To learn how to use these tools, you may want to read this article.

• redoc

  35 22,562 7.9 TypeScript

  📘 OpenAPI/Swagger-generated API Reference Documentation

  

You don't specify which type of API you're dealing with, but I guess it's a REST API. If this is the case, you'll probably be able to render a Swagger UI or Redoc interface to the API. This is very useful to help you see all the endpoints available as well as the schemas, and play around with the server. Different frameworks have different endpoints to access this UI and I highly recommend you check this out since it'll help you a lot to understand the API.

Suggest a related project