HacktoberFest OpenSource URLShortener Application - Participate in Hacktoberfest by contributing to any Open Source project on GitHub! Here is a starter project for first time contributors. #hacktoberfest
Currently, there is no Postman documentation available for the URL shortening service. Developers do not have a straightforward way to test or integrate the API endpoints using tools like Postman. The lack of a Postman collection makes it difficult for developers to interact with the service for testing, debugging, and understanding the available endpoints.
Suggested Changes
Create a Postman Collection:
Develop a Postman collection that includes all available API endpoints for the URL shortening service (e.g., URL shortening, URL redirection, URL expiry, etc.).
The collection should include details for each request, such as request type (GET, POST), parameters (e.g., URL, keyword, expiry), and expected responses.
Link Postman Collection in Documentation:
Add a section to the API documentation page on the website that links directly to the Postman collection.
Provide instructions on how to import the collection into Postman, as well as how to use the requests for testing and integration.
Include Example Requests & Responses:
Include example API requests and sample responses for each endpoint to help developers better understand how the service works.
Current Documentation
Currently, there is no Postman documentation available for the URL shortening service. Developers do not have a straightforward way to test or integrate the API endpoints using tools like Postman. The lack of a Postman collection makes it difficult for developers to interact with the service for testing, debugging, and understanding the available endpoints.
Suggested Changes
Create a Postman Collection:
Link Postman Collection in Documentation:
Include Example Requests & Responses:
Additional Resources
These resources can help in building the Postman collection and improving the documentation experience for developers.