diff --git a/README.md b/README.md index 1c2c8f6..f38e450 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ # API Wrapper Boilerplate + +## Example Code +The example code in `main.py` uses the [JSONPlaceholder](https://jsonplaceholder.typicode.com/) demo API, which +is a great resource for learning how to work with JSON based REST APIs. + +The example code also demonstrates how the wrapper will raise exceptions by initializing the `ApiWrapper` with +a broken proxy. + +## Development +The ApiWrapper class includes private class convenience methods that utilize the internal `requests.Session` +object to persist session data across all API requests. When developing public methods, use the appropriate +convenience methods: +- `self.__get` +- `self.__post` +- `self.__put` +- `self.__delete` + +## Error Handling +The ApiWrapper class defines custom exceptions for handling API request and response errors. +- ApiRequestException is raised when there is an issue with the API request. +- InvalidApiResponse is raised when the API response is not a valid JSON. + +You can catch these exceptions and handle them accordingly in your code.