Overview:
Is your feature request related to a problem? Please describe.
Currently, interacting with our service's API requires manually crafting HTTP requests, which is error-prone and inefficient. This process lacks standardization and makes it difficult for new developers to onboard. Additionally, there's no easy way to test the API endpoints or generate client libraries for different programming languages, which limits our API's accessibility and usability.
Describe the solution you'd like
The solution involves creating a standardized, easy-to-use API client that can be easily integrated into various development environments. This process includes creating a Postman collection for the API, converting that collection into an OpenAPI specification, and then using AutoRest to generate an API client specifically for Swift. Additionally, we want to implement custom functions such as uploadCard(frontImage, backImage) and checkEligibility(card_id) to enhance the Swift API client's functionality.
Goal:
To streamline the development process, improve API testing capabilities, and enhance accessibility for developers by providing them with a robust, auto-generated API client in Swift. This should significantly reduce the time and effort required to integrate with our API and improve the overall developer experience.
Tasks
Acceptance Criteria
Overview:
Is your feature request related to a problem? Please describe.
Currently, interacting with our service's API requires manually crafting HTTP requests, which is error-prone and inefficient. This process lacks standardization and makes it difficult for new developers to onboard. Additionally, there's no easy way to test the API endpoints or generate client libraries for different programming languages, which limits our API's accessibility and usability.
Describe the solution you'd like
The solution involves creating a standardized, easy-to-use API client that can be easily integrated into various development environments. This process includes creating a Postman collection for the API, converting that collection into an OpenAPI specification, and then using AutoRest to generate an API client specifically for Swift. Additionally, we want to implement custom functions such as
uploadCard(frontImage, backImage)andcheckEligibility(card_id)to enhance the Swift API client's functionality.Goal:
To streamline the development process, improve API testing capabilities, and enhance accessibility for developers by providing them with a robust, auto-generated API client in Swift. This should significantly reduce the time and effort required to integrate with our API and improve the overall developer experience.
Tasks
uploadCard(frontImage, backImage)andcheckEligibility(card_id), to meet specific use cases not covered by standard CRUD operations.Acceptance Criteria