카우치베이스 incorporated Swagger into our documentation a few months ago. “Swagger” refers to an ecosystem of tools and other resources for managing REST APIs.
Core to Swagger is the Swagger specification. (The group behind Swagger donated the spec to the OpenAPI Initiative. The original site, swagger.io remains the main site for tools and such.)
Once you have the API spec defined for you endpoints, you get several valuable capabilities. My two favorite are the “live” embeddable documentation and the client libraries. Take a look at this short video for a demonstration of some of the features of Swagger.
[youtube https://www.youtube.com/watch?v=0UWiE-c9Nds&w=560&h=315]
For an example of using a Swagger JavaScript client, take a look at this blog post: https://www.couchbase.com/blog/node-js-swagger-monitor-document-changes-couchbase-mobile/
You can find the Swagger specs for the Sync Gateway public API 여기, and the admin API 여기.
Here are the Sync Gateway configurations I refer to in the video. The first has the CORS configuration to allow access from swagger.io.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ “log”: [“*”], “CORS”: { “Origin”:[“*”], “Headers”: [“Content-Type”] }, “databases”: { “db”: { “server”: “walrus:”, “users”: { “GUEST”: { “disabled”: false, “admin_channels”: [“*”] } }, “allow_empty_password”: true } } } |
The second is for trying out calls through our live documentation.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
{ “log”: [ “*” ], “SSLCert”: “cert.pem”, “SSLKey”: “privkey.pem”, “CORS”: { “Origin”: [“*”], “Headers”: [“Content-Type”] }, “databases”: { “db”: { “server”: “walrus:”, “users”: { “GUEST”: { “disabled”:false, “admin_channels”: [ “*” ] } } } } } |
(Note: There’s currently a known issue with making the calls from the Couchbase documentation. Couchbase now requires access via https, in keeping with security best practices. This means the documentation also redirects using https. This means you have to set up Sync Gateway to use SSL. See the documentation 여기 for more information.)
Postscript
Download Couchbase and Sync Gateway 여기. See our 문서화 for how to add Couchbase Lite to a project.
Check out more resources on our 개발자 포털 and follow us on Twitter @CouchbaseDev.
You can post questions on our forums. And we actively participate on 스택 오버플로.
Hit me up on Twitter with any questions, comments, topics you’d like to see, etc. @HodGreeley
댓글 남기기
댓글을 달기 위해서는 로그인해야합니다.