GitBook: [master] 4 pages and one asset modified

This commit is contained in:
Chris Busch
2020-11-29 22:01:33 +00:00
committed by gitbook-bot
parent 0fb203bdc2
commit e3270053d1
4 changed files with 32 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 177 KiB

View File

@@ -14,7 +14,8 @@
* [Profiles](user-interface/profiles.md)
* [System](user-interface/system.md)
* [Accounts](user-interface/accounts.md)
* [API](api.md)
* [API](api/README.md)
* [Swagger](api/swagger.md)
## Solution Use Cases

30
api/swagger.md Normal file
View File

@@ -0,0 +1,30 @@
# Swagger
TIP Open Wi-Fi controller implements an Open API compliant NorthBound Interface \(NBI\) to assist with integration and related back office features.
Swagger is a useful tool to explore and learn any system API.
### Obtain latest TIP Controller Open API data model
{% embed url="https://github.com/Telecominfraproject/wlan-cloud-services/blob/master/portal-services/src/main/resources/portal-services-openapi.yaml" caption="TIP Github repo link to Open API data model " %}
### Install Swagger
```text
mkdir ~/swagger
cd ~/swagger
git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
git clone https://github.com/swagger-api/swagger-ui.git
cd ~/swagger/swagger-editor
npm install
npm run build
npm start
```
With Swagger running, open the Open API data model file and begin to use locally on port 9091 or add your own TIP Open Wi-Fi controller to the Swagger definitions. Remember to obtain an [OAuth bearer ](./#curl-request-to-controller-for-bearer-token)token to 'Authorize' your session.
![Successful login to Swagger on localhost:9091 ](../.gitbook/assets/swagger.jpeg)