Provides OpenAPI Specification (v3) definitions for Nexmo APIs.
View rendered API specifications
(Raw specification files are in definitions/)
These definitions provide a single point of truth that can be used end-to-end:
- 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.
- What is OpenAPI?
- A Visual Guide to What's New in Swagger 3.0
- OAS3 Documentation
- OAS3 Specification
- OAS3 Examples
- Nexmo OAS Renderer - Nexmo's tool for rendering OpenAPI specs to HTML.
- Nexmo Developer - Nexmo Developer uses these specs and the renderer for the API reference pages.
- Swagger Editor - Can be used to edit OAS3 definitions, provides live reloading Swagger UI.
- 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
Contributions are welcome, please follow GitHub Flow