...
Introduction
REST is not a standard , but a Web application development architectural style, which can be understood as a design pattern. REST-based HTTP, URI, XML and widely popular these existing protocols and standards, along with REST, HTTP protocol to obtain a more correct use. Compared to SOAP and WSDL-based Web services, REST model provides a more concise compared to realization.
REST API using the resource positioning, WEB service interface is provided externally and announced a series of URI parameters.
...
http(s)://[hostname][:port]/[ServiceType]/[ServiceName]/[Service Version]/[PathInfo]
ServiceType
Service Type?openoapiapi and openouiui(UI)
ServicesName
Service Name, a globally unique
...
| ServiceType | ServiceName | ServiceVersion | PathInfo |
|---|---|---|---|
| openoapiapi | catalog | v1 | /servicetemplates |
| openoapiapi | catalog | v1 | /servicetemplates/{serviceTemplateId} |
| oepnouiui | log | v1 | /info/syslogs |
| oepnouiui | log | v1 | /statisticinfo/syslogs |
...
| Function | scheme://[host]:[port]/path | queryString |
|---|---|---|
| API Service Specification | [[host\]]:[port]/openoapiapi/[Service Name]/v[Version Number]/[Resource]/ | queryparam1=xxx, queryparam2=xxx |
| Content Service Specification | [[host\]]:[port]/openouiui/[Content of the resource]/index.html | None |
...
| Function | scheme://[host]:[port]/path | queryString |
|---|---|---|
| log API Service | [[host\:\[port\]/openoapiapi/log/v1/loginfo/syslogs]] | starttime=xxxx Endtime=xxxx |
| log Content Service | [[host\:\[port\]/openouiui/log/]] | |
| alarm API Service | [[host\:\[port\]/openoapiapi/fm/v1/alarms]] | |
| alarm Content Service | [[host\:\[port\]/openouiui/fm/]] |
Use path variables to express the resource hierarchy
...
View a device information in topology:
http://127.0.0.1/openoapiapi/topo/v1/resources/{Resourcelocate id}
View a user information in safe module?
http://127.0.0.1/openoapiapi/sm/v1/users/{userid}
Path variable expression using punctuation non-hierarchical structure
...
View all link information between two nes in topology:
http://127.0.0.1/openoapiapi/topo/v1/links/{ne id1};{ne id2}
View all link information from one ne to another ne in topology:
http://127.0.0.1/openoapiapi/topo/V1/links/{ne id1},{ne id2}
...
View a system log information
http://127.0.0.1/openoapiapi/log/v1/syslogs?id=101&filter=admin&count=50
...