API Specifications
Provides Open API Specification 3 definitions for Nexmo APIs.
These definitions provide a single point of truth that can be used end-to-end can we used to:
- Planning Shared during product discussions for planning API functionality
- Implementation Inform engineering during development
- Testing As the basis for testing or mocking API endpoints
- Documentation For producing thorough and interactive documentation
- Tooling To generate server stubs and client SDKs.
Definitions
| API | Definition owner | Contributors |
|---|---|---|
| SMS | - | Adam Butler |
| Voice | - | - |
| Verify | - | - |
| Number Insight | - | - |
| Conversation | Neil Stratford | Adam Butler |
| Olympus | Hugh Hopkins | |
| Account | - | - |
| Messages | - | - |
| Messages | - | - |
| Numbers | - | - |
| Application | - | - |
| Conversion | - | - |
Resources
- What is OpenAPI?
- A Visual Guide to What's New in Swagger 3.0
- OAS3 Documentation
- OAS3 Specification
- OAS3 Examples
Tools
- Swagger Editor - Can be used to edit OAS3 definitions, provides live reloading Swagger UI.
- Swagger 2.0 to OAS3 converter - Unofficial converter that can be used to convert existing Swagger 2.0 definitions to OAS3 definitions.
- Swagger Codegen - A template-driven engine to generate documentation, API clients and server stubs in different languages by parsing OAS3 definitions.
- Swagger Parser - Standalone library for parsing OAS3 definitions from Java
- Nexmo Developer - Nexmo Developer has it's own OAS3 definition parser and API reference UI.
Contributing
Contributions are welcome, please follow GitHub Flow