Skip to content
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

Commit 650b103

Browse files
lucashuet93lucashuet93
authored
Merge branch 'master' into odaibert/mergedLucas
2 parents 21fac13 + 685097a commit 650b103

18 files changed

+483
-0
lines changed

‎example/demo/Input/apiPolicyHeaders.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<policies>
2+
<inbound>
3+
<base />
4+
</inbound>
5+
<backend>
6+
<base />
7+
</backend>
8+
<outbound>
9+
<set-header name="X-Powered-By" exists-action="delete" />
10+
<set-header name="X-AspNet-Version" exists-action="delete" />
11+
<base />
12+
</outbound>
13+
<on-error>
14+
<base />
15+
</on-error>
16+
</policies>

‎example/demo/Input/operationRateLimit.xml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<policies>
2+
<inbound>
3+
<rate-limit-by-key calls="3" renewal-period="15" counter-key="@(context.Subscription.Id)" />
4+
<base />
5+
</inbound>
6+
<backend>
7+
<base />
8+
</backend>
9+
<outbound>
10+
<base />
11+
</outbound>
12+
<on-error>
13+
<base />
14+
</on-error>
15+
</policies>

‎example/demo/Input/swaggerPetstore.json

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "1.0.0",
5+
"title": "Swagger Petstore",
6+
"description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
7+
"termsOfService": "http://swagger.io/terms/",
8+
"contact": {
9+
"name": "Swagger API Team",
10+
"email": "apiteam@swagger.io",
11+
"url": "http://swagger.io"
12+
},
13+
"license": {
14+
"name": "Apache 2.0",
15+
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
16+
}
17+
},
18+
"host": "petstore.swagger.io",
19+
"basePath": "/api",
20+
"schemes": [
21+
"http"
22+
],
23+
"consumes": [
24+
"application/json"
25+
],
26+
"produces": [
27+
"application/json"
28+
],
29+
"paths": {
30+
"/pets": {
31+
"get": {
32+
"description": "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\n",
33+
"operationId": "findPets",
34+
"parameters": [
35+
{
36+
"name": "tags",
37+
"in": "query",
38+
"description": "tags to filter by",
39+
"required": false,
40+
"type": "array",
41+
"collectionFormat": "csv",
42+
"items": {
43+
"type": "string"
44+
}
45+
},
46+
{
47+
"name": "limit",
48+
"in": "query",
49+
"description": "maximum number of results to return",
50+
"required": false,
51+
"type": "integer",
52+
"format": "int32"
53+
}
54+
],
55+
"responses": {
56+
"200": {
57+
"description": "pet response",
58+
"schema": {
59+
"type": "array",
60+
"items": {
61+
"$ref": "#/definitions/Pet"
62+
}
63+
}
64+
},
65+
"default": {
66+
"description": "unexpected error",
67+
"schema": {
68+
"$ref": "#/definitions/Error"
69+
}
70+
}
71+
}
72+
},
73+
"post": {
74+
"description": "Creates a new pet in the store. Duplicates are allowed",
75+
"operationId": "addPet",
76+
"parameters": [
77+
{
78+
"name": "pet",
79+
"in": "body",
80+
"description": "Pet to add to the store",
81+
"required": true,
82+
"schema": {
83+
"$ref": "#/definitions/NewPet"
84+
}
85+
}
86+
],
87+
"responses": {
88+
"200": {
89+
"description": "pet response",
90+
"schema": {
91+
"$ref": "#/definitions/Pet"
92+
}
93+
},
94+
"default": {
95+
"description": "unexpected error",
96+
"schema": {
97+
"$ref": "#/definitions/Error"
98+
}
99+
}
100+
}
101+
}
102+
},
103+
"/pets/{id}": {
104+
"get": {
105+
"description": "Returns a user based on a single ID, if the user does not have access to the pet",
106+
"operationId": "find pet by id",
107+
"parameters": [
108+
{
109+
"name": "id",
110+
"in": "path",
111+
"description": "ID of pet to fetch",
112+
"required": true,
113+
"type": "integer",
114+
"format": "int64"
115+
}
116+
],
117+
"responses": {
118+
"200": {
119+
"description": "pet response",
120+
"schema": {
121+
"$ref": "#/definitions/Pet"
122+
}
123+
},
124+
"default": {
125+
"description": "unexpected error",
126+
"schema": {
127+
"$ref": "#/definitions/Error"
128+
}
129+
}
130+
}
131+
},
132+
"delete": {
133+
"description": "deletes a single pet based on the ID supplied",
134+
"operationId": "deletePet",
135+
"parameters": [
136+
{
137+
"name": "id",
138+
"in": "path",
139+
"description": "ID of pet to delete",
140+
"required": true,
141+
"type": "integer",
142+
"format": "int64"
143+
}
144+
],
145+
"responses": {
146+
"204": {
147+
"description": "pet deleted"
148+
},
149+
"default": {
150+
"description": "unexpected error",
151+
"schema": {
152+
"$ref": "#/definitions/Error"
153+
}
154+
}
155+
}
156+
}
157+
}
158+
},
159+
"definitions": {
160+
"Pet": {
161+
"type": "object",
162+
"allOf": [
163+
{
164+
"$ref": "#/definitions/NewPet"
165+
},
166+
{
167+
"required": [
168+
"id"
169+
],
170+
"properties": {
171+
"id": {
172+
"type": "integer",
173+
"format": "int64"
174+
}
175+
}
176+
}
177+
]
178+
},
179+
"NewPet": {
180+
"type": "object",
181+
"required": [
182+
"name"
183+
],
184+
"properties": {
185+
"name": {
186+
"type": "string"
187+
},
188+
"tag": {
189+
"type": "string"
190+
}
191+
}
192+
},
193+
"Error": {
194+
"type": "object",
195+
"required": [
196+
"code",
197+
"message"
198+
],
199+
"properties": {
200+
"code": {
201+
"type": "integer",
202+
"format": "int32"
203+
},
204+
"message": {
205+
"type": "string"
206+
}
207+
}
208+
}
209+
}
210+
}

‎example/demo/Input/valid.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
version: 0.0.1 # Required
2+
apimServiceName: ContosoApim # Required, must match name of an apim service deployed in the specified resource group
3+
apiVersionSet: # Optional
4+
displayName: myAPIVersionSet
5+
description: a description
6+
versioningScheme: Query
7+
versionQueryName: versionQuery
8+
versionHeaderName: versionHeader
9+
api:
10+
name: myAPI # Required
11+
openApiSpec: /Users/miaojiang/Work/APIM-Demo/DevOps-Demo/Input/swaggerPetstore.json # Required, can be url or local file
12+
#openApiSpec: https://petstore.swagger.io/v2/swagger.json
13+
policy: /Users/miaojiang/Work/APIM-Demo/DevOps-Demo/Input/apiPolicyHeaders.xml # Optional, can be url or local file
14+
suffix: myAPIPet # Required
15+
apiVersion: v1 # Optional
16+
apiVersionDescription: My first version # Optional
17+
revision: 1 # Optional
18+
revisionDescription: My first revision # Optional
19+
operations: # Optional
20+
addPet: # Must match the operationId property of a path's operations
21+
policy: /Users/miaojiang/Work/APIM-Demo/DevOps-Demo/Input/operationRateLimit.xml # Optional, can be url or local file
22+
deletePet: # Must match the operationId property of a path's operations
23+
policy: /Users/miaojiang/Work/APIM-Demo/DevOps-Demo/Input/operationRateLimit.xml # Optional, can be url or local file
24+
authenticationSettings: # Optional
25+
subscriptionKeyRequired: false
26+
#oAuth2:
27+
# authorizationServerId: apimgmtaad
28+
# scope: scope
29+
products: starter # Optional, adds api to the specified products
30+
outputLocation: /Users/miaojiang/Work/APIM-Demo/DevOps-Demo/Output/ # Required, folder the creator will write the templates to
31+
linked: true # Optional
32+
linkedTemplatesBaseUrl : https://raw.githubusercontent.com/miaojiang/APIM-Demo/master/DevOps-Demo/Output/ # Required if 'linked' property is set to true

‎example/demo/Output/initialAPI.template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#","contentVersion":"1.0.0.0","parameters":{"ApimServiceName":{"type":"string"}},"resources":[{"properties":{"authenticationSettings":{"subscriptionKeyRequired":false},"apiRevision":"1","apiVersion":"v1","apiRevisionDescription":"My first revision","apiVersionDescription":"My first version","apiVersionSetId":"[resourceId('Microsoft.ApiManagement/service/api-version-sets', parameters('ApimServiceName'), 'versionset')]","displayName":"myAPI","path":"myAPIPet","protocols":["http"]},"name":"[concat(parameters('ApimServiceName'), '/myAPI')]","type":"Microsoft.ApiManagement/service/apis","apiVersion":"2018-01-01","dependsOn":[]}]}

‎example/demo/Output/master.parameters.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#","contentVersion":"1.0.0.0","parameters":{"ApimServiceName":{"value":"ContosoApim"},"LinkedTemplatesBaseUrl":{"value":"https://raw.githubusercontent.com/miaojiang/APIM-Demo/master/DevOps-Demo/Output/"}},"resources":[]}

‎example/demo/Output/master.template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#","contentVersion":"1.0.0.0","parameters":{"ApimServiceName":{"type":"string","metadata":{"description":"Name of the API Management"}},"LinkedTemplatesBaseUrl":{"type":"string","metadata":{"description":"Base URL of the repository"}}},"resources":[{"properties":{"mode":"Incremental","templateLink":{"uri":"[concat(parameters('LinkedTemplatesBaseUrl'), '/versionset.template.json')]","contentVersion":"1.0.0.0"},"parameters":{"ApimServiceName":{"value":"[parameters('ApimServiceName')]"}}},"name":"versionSetTemplate","type":"Microsoft.Resources/deployments","apiVersion":"2018-01-01","dependsOn":[]},{"properties":{"mode":"Incremental","templateLink":{"uri":"[concat(parameters('LinkedTemplatesBaseUrl'), '/initialAPI.template.json')]","contentVersion":"1.0.0.0"},"parameters":{"ApimServiceName":{"value":"[parameters('ApimServiceName')]"}}},"name":"initialAPITemplate","type":"Microsoft.Resources/deployments","apiVersion":"2018-01-01","dependsOn":["[resourceId('Microsoft.Resources/deployments', 'versionSetTemplate')]"]},{"properties":{"mode":"Incremental","templateLink":{"uri":"[concat(parameters('LinkedTemplatesBaseUrl'), '/subsequentAPI.template.json')]","contentVersion":"1.0.0.0"},"parameters":{"ApimServiceName":{"value":"[parameters('ApimServiceName')]"}}},"name":"subsequentAPITemplate","type":"Microsoft.Resources/deployments","apiVersion":"2018-01-01","dependsOn":["[resourceId('Microsoft.Resources/deployments', 'initialAPITemplate')]"]}]}

‎example/demo/Output/subsequentAPI.template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#","contentVersion":"1.0.0.0","parameters":{"ApimServiceName":{"type":"string"}},"resources":[{"properties":{"path":"myAPIPet","contentValue":"{\"swagger\":\"2.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Swagger Petstore\",\"description\":\"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification\",\"termsOfService\":\"http://swagger.io/terms/\",\"contact\":{\"name\":\"Swagger API Team\",\"email\":\"apiteam@swagger.io\",\"url\":\"http://swagger.io\"},\"license\":{\"name\":\"Apache 2.0\",\"url\":\"https://www.apache.org/licenses/LICENSE-2.0.html\"}},\"host\":\"petstore.swagger.io\",\"basePath\":\"/api\",\"schemes\":[\"http\"],\"consumes\":[\"application/json\"],\"produces\":[\"application/json\"],\"paths\":{\"/pets\":{\"get\":{\"description\":\"Returns all pets from the system that the user has access to\\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\\n\\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\\n\",\"operationId\":\"findPets\",\"parameters\":[{\"name\":\"tags\",\"in\":\"query\",\"description\":\"tags to filter by\",\"required\":false,\"type\":\"array\",\"collectionFormat\":\"csv\",\"items\":{\"type\":\"string\"}},{\"name\":\"limit\",\"in\":\"query\",\"description\":\"maximum number of results to return\",\"required\":false,\"type\":\"integer\",\"format\":\"int32\"}],\"responses\":{\"200\":{\"description\":\"pet response\",\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Pet\"}}},\"default\":{\"description\":\"unexpected error\",\"schema\":{\"$ref\":\"#/definitions/Error\"}}}},\"post\":{\"description\":\"Creates a new pet in the store. Duplicates are allowed\",\"operationId\":\"addPet\",\"parameters\":[{\"name\":\"pet\",\"in\":\"body\",\"description\":\"Pet to add to the store\",\"required\":true,\"schema\":{\"$ref\":\"#/definitions/NewPet\"}}],\"responses\":{\"200\":{\"description\":\"pet response\",\"schema\":{\"$ref\":\"#/definitions/Pet\"}},\"default\":{\"description\":\"unexpected error\",\"schema\":{\"$ref\":\"#/definitions/Error\"}}}}},\"/pets/{id}\":{\"get\":{\"description\":\"Returns a user based on a single ID, if the user does not have access to the pet\",\"operationId\":\"find pet by id\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"ID of pet to fetch\",\"required\":true,\"type\":\"integer\",\"format\":\"int64\"}],\"responses\":{\"200\":{\"description\":\"pet response\",\"schema\":{\"$ref\":\"#/definitions/Pet\"}},\"default\":{\"description\":\"unexpected error\",\"schema\":{\"$ref\":\"#/definitions/Error\"}}}},\"delete\":{\"description\":\"deletes a single pet based on the ID supplied\",\"operationId\":\"deletePet\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"ID of pet to delete\",\"required\":true,\"type\":\"integer\",\"format\":\"int64\"}],\"responses\":{\"204\":{\"description\":\"pet deleted\"},\"default\":{\"description\":\"unexpected error\",\"schema\":{\"$ref\":\"#/definitions/Error\"}}}}}},\"definitions\":{\"Pet\":{\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/definitions/NewPet\"},{\"required\":[\"id\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"}}}]},\"NewPet\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"}}},\"Error\":{\"type\":\"object\",\"required\":[\"code\",\"message\"],\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"message\":{\"type\":\"string\"}}}}}","contentFormat":"swagger-json"},"name":"[concat(parameters('ApimServiceName'), '/myAPI')]","type":"Microsoft.ApiManagement/service/apis","apiVersion":"2018-01-01","dependsOn":[]},{"properties":{"policyContent":"<policies>\r\n <inbound>\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <set-header name=\"X-Powered-By\" exists-action=\"delete\" />\r\n <set-header name=\"X-AspNet-Version\" exists-action=\"delete\" />\r\n <base />\r\n </outbound>\r\n <on-error>\r\n <base />\r\n </on-error>\r\n</policies>","contentFormat":"rawxml"},"name":"[concat(parameters('ApimServiceName'), '/myAPI/policy')]","type":"Microsoft.ApiManagement/service/apis/policies","apiVersion":"2018-01-01","dependsOn":["[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), 'myAPI')]"]},{"properties":{"policyContent":"<policies>\r\n <inbound>\r\n <rate-limit-by-key calls=\"3\" renewal-period=\"15\" counter-key=\"@(context.Subscription.Id)\" />\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n <on-error>\r\n <base />\r\n </on-error>\r\n</policies>","contentFormat":"rawxml"},"name":"[concat(parameters('ApimServiceName'), '/myAPI/addPet/policy')]","type":"Microsoft.ApiManagement/service/apis/operations/policies","apiVersion":"2018-01-01","dependsOn":["[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), 'myAPI')]"]},{"properties":{"policyContent":"<policies>\r\n <inbound>\r\n <rate-limit-by-key calls=\"3\" renewal-period=\"15\" counter-key=\"@(context.Subscription.Id)\" />\r\n <base />\r\n </inbound>\r\n <backend>\r\n <base />\r\n </backend>\r\n <outbound>\r\n <base />\r\n </outbound>\r\n <on-error>\r\n <base />\r\n </on-error>\r\n</policies>","contentFormat":"rawxml"},"name":"[concat(parameters('ApimServiceName'), '/myAPI/deletePet/policy')]","type":"Microsoft.ApiManagement/service/apis/operations/policies","apiVersion":"2018-01-01","dependsOn":["[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), 'myAPI')]"]},{"properties":{},"name":"[concat(parameters('ApimServiceName'), '/starter/myAPI')]","type":"Microsoft.ApiManagement/service/products/apis","apiVersion":"2018-01-01","dependsOn":["[resourceId('Microsoft.ApiManagement/service/apis', parameters('ApimServiceName'), 'myAPI')]"]}]}

‎example/demo/Output/versionset.template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#","contentVersion":"1.0.0.0","parameters":{"ApimServiceName":{"type":"string"}},"resources":[{"properties":{"displayName":"myAPIVersionSet","description":"a description","versionQueryName":"versionQuery","versionHeaderName":"versionHeader","versioningScheme":"Query"},"name":"[concat(parameters('ApimServiceName'), '/versionset')]","type":"Microsoft.ApiManagement/service/api-version-sets","apiVersion":"2018-01-01","dependsOn":[]}]}

0 commit comments

Comments
 (0)