RESTfly: Simplifying API Libraries¶
Release v1.5.1.
RESTfly (pronounced restfully) is a framework for building libraries to easily interact with RESTful APIs.
The User Guide¶
This part of the documentation focuses on walking through usage of the library in a step-by-step manner.
Note
Please note that this section of the documentation is currently still being constructed, and should not be considered a complete walkthrough.
Libraries and Tools Using RESTfly¶
RESTfly is based on the foundational work in the pyTenable project. We took the lessons learned building that library and made the underlying structure generic for re-use building other API libraries. There are several other projects also leveraging RESTfly listed below:
The API Documentation / Guide¶
If you are looking for information on a specific function, class, or method, this part of the documentation is what you’re looking for.
Reference Guide
- Endpoints
- Errors
RestflyExceptionUnexpectedValueErrorRequiredParameterErrorAPIErrorBadRequestErrorUnauthorizedErrorForbiddenErrorNotFoundErrorInvalidMethodErrorNotAcceptableErrorProxyAuthenticationErrorRequestTimeoutErrorRequestConflictErrorNoLongerExistsErrorLengthRequiredErrorPreconditionFailedErrorPayloadTooLargeErrorURITooLongErrorUnsupportedMediaTypeErrorRangeNotSatisfiableErrorExpectationFailedErrorTeapotResponseErrorMisdirectRequestErrorInvalidContentErrorTooEarlyErrorUpgradeRequiredErrorPreconditionRequiredErrorTooManyRequestsErrorRequestHeaderFieldsTooLargeErrorUnavailableForLegalReasonsErrorServerErrorMethodNotImplementedErrorBadGatewayErrorServiceUnavailableErrorGatewayTimeoutErrorNotExtendedErrorNetworkAuthenticationRequiredError
- Iterators
- Sessions
- Utils