Definition
Swagger is an API documentation and testing tool suite based on the OpenAPI specification, providing readable API descriptions, interactive documentation, and online debugging capabilities. In the International IoT Cloud Platform (ICMP), Swagger makes it easier for developers to understand and integrate RESTful APIs, lowers the threshold for connecting to API Gateway, and, when used together with SDK, accelerates customer system integration.
Working Principle
Swagger uses OpenAPI (formerly Swagger specification) in YAML/JSON format to describe APIs: endpoints, methods, parameters, request/response structures, authentication methods, and so on. Swagger UI renders the specification into readable documentation, supporting "Try it out" online calls, allowing developers to test APIs without leaving the browser. The specification can also be used to automatically generate SDK, Mock services, API Gateway configurations, and more. ICMP's RESTful APIs usually provide Swagger documentation, displayed together with OAuth2 and API Key authentication instructions.
Use Cases
Typical scenarios include: Developer Integration — Customer developers understand API capabilities through Swagger documentation, debug online, and then integrate into their own systems; POC and Pilot — Quickly verify API functions and parameters during the POC phase; Reseller Integration — Channel technical teams integrate ICMP capabilities into the Partner Portal via Swagger; Internal Collaboration — Front-end and back-end teams collaborate based on unified standards, reducing communication costs. Together with Audit Trail , API calls are traceable, supporting issue troubleshooting and compliance audits.
Practice in ICMP
SimtoLink ICMP's RESTful API provides complete Swagger/OpenAPI documentation, covering SIM management, usage query, billing, PLMN Selection , Event Subscription , and other capabilities. Documentation is updated in sync with API Gateway , supporting authentication instructions and online authorization for OAuth2 and API Key. Developers can generate multi-language SDK based on the specifications, or directly use the documentation for integration. Combined with TLS encryption and IAM authentication, the security and compliance of documentation and API access are ensured.