API documentation guide
Guide how to use Swagger and swaggerv2dcc directive
Add 2 JSON Swagger files
Add code block
Change-Id: If3af3f20509db2cc47bdb2cf3db9b44d8a1bcdc7
Issue-ID: DOC-426
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
diff --git a/docs/guides/onap-developer/how-to-use-docs/myAPI2.json b/docs/guides/onap-developer/how-to-use-docs/myAPI2.json
new file mode 100644
index 0000000..473d351
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/myAPI2.json
@@ -0,0 +1,37 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "description" : "my API 2",
+ "version" : "1.0.0",
+ "title" : "API example",
+ "contact" : {
+ "email" : "onap@orange.com"
+ },
+ "license" : {
+ "name" : "Apache 2.0",
+ "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
+ }
+ },
+ "host" : "serverRoot",
+ "basePath" : "/status",
+ "schemes" : [ "https" ],
+ "produces": [
+ "application/json;charset=utf-8"
+ ],
+ "paths" : {
+ "/status" : {
+ "get" : {
+ "summary" : "Displays status for my favorite component",
+ "description" : "Displays status for my favorite component",
+ "responses": {
+ "200": {
+ "description": "Service OK"
+ },
+ "503" : {
+ "description" : "Service Unavailable"
+ }
+ }
+ }
+ }
+ }
+}