[prev in list] [next in list] [prev in thread] [next in thread]
List: esb-java-dev
Subject: Re: [Dev] Struggling to create a API using official publisher REST APIs document.
From: Pasindu Jayaweera <pasinduj () wso2 ! com>
Date: 2019-11-25 2:30:31
Message-ID: CA+z_hBBx+JrTzGvAx+wz0KXh8D7PT_F6dH0eqP-P1hW2DgTMpw () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
Hi Shiva,
As per your message, it seems you are sending a PUT request. But to create
a new API, you should be sending a *POST* request. (PUT is used to update
an existing API)
Try with POST request and check.
Regards,
On Wed, Nov 13, 2019 at 2:58 AM Shiva Kumar <shiva.k@securelyshare.com>
wrote:
> Hi Team,
>
> I am following below document and I could not able understand how to
> create an API using WSO2 APIM 2.1.0 Publish APIs below is the document I
> am following but getting 403 forbidden. Below are the steps I followed.
>
> 1. I created an oauth application from admin console.
>
> 2. I used admin user and it's password to get password grant type token
> with scopes apim:api_create, apim:api_view, apim:api_publish.
>
> 3. I used the token obtained from above step and used sample payload
> given in document
>
> https://docs.wso2.com/display/AM210/apidocs/publisher/#!/operations#APIIndividual#apisPost
> to create an API.
>
> 4. Got 403 forbidden response.
>
>
> Request:
>
> PUT http://localhost:9773/api/am/publisher/v0.11/apis
>
> {
> "name": "PizzaShackAPI",
> "description": "This document describe a RESTFul API for Pizza
> Shack online pizza delivery store.\r\n",
> "context": "/pizzashack",
> "version": "1.0.0",
> "provider": "admin",
> "apiDefinition":
> "{\"paths\":{\"/order\":{\"post\":{\"x-auth-type\":\"Application &
> Application
> User\",\"x-throttling-tier\":\"Unlimited\",\"description\":\"Create a
> new
> Order\",\"parameters\":[{\"schema\":{\"$ref\":\"#/definitions/Order\"},\"description\":\"Order
>
> object that needs to be
> added\",\"name\":\"body\",\"required\":true,\"in\":\"body\"}],\"responses\":{\"201\":{\"headers\":{\"Location\":{\"description\":\"The
>
> URL of the newly created
> resource.\",\"type\":\"string\"}},\"schema\":{\"$ref\":\"#/definitions/Order\"},\"description\":\"Created.\"}}}},\"/menu\":{\"get\":{\"x-auth-type\":\"Application
>
> & Application
> User\",\"x-throttling-tier\":\"Unlimited\",\"description\":\"Return a
> list of available menu
> items\",\"parameters\":[],\"responses\":{\"200\":{\"headers\":{},\"schema\":{\"title \
> \":\"Menu\",\"properties\":{\"list\":{\"items\":{\"$ref\":\"#/definitions/MenuItem\" \
> },\"type\":\"array\"}},\"type\":\"object\"},\"description\":\"OK.\"}}}}},\"schemes\" \
> :[\"https\"],\"produces\":[\"application/json\"],\"swagger\":\"2.0\",\"definitions\":{\"MenuItem\":{\"title\":\"Pizza
>
> menu
> Item\",\"properties\":{\"price\":{\"type\":\"string\"},\"description\":{\"type\":\"s \
> tring\"},\"name\":{\"type\":\"string\"},\"image\":{\"type\":\"string\"}},\"required\":[\"name\"]},\"Order\":{\"title\":\"Pizza
>
> Order\",\"properties\":{\"customerName\":{\"type\":\"string\"},\"delivered\":{\"type \
> \":\"boolean\"},\"address\":{\"type\":\"string\"},\"pizzaType\":{\"type\":\"string\" \
> },\"creditCardNumber\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"or \
> derId\":{\"type\":\"integer\"}},\"required\":[\"orderId\"]}},\"consumes\":[\"application/json\"],\"info\":{\"title\":\"PizzaShackAPI\",\"description\":\"This
>
> document describe a RESTFul API for Pizza Shack online pizza delivery
> store.\\n\",\"license\":{\"name\":\"Apache
> 2.0\",\"url\":\"http://www.apache.org/licenses/LICENSE-2.0.html\
> "},\"contact\":{\"email\":\"architecture@pizzashack.com\",\"name\":\"John
> Doe\",\"url\":\"http://www.pizzashack.com\"},\"version\":\"1.0.0\"}}",
> "wsdlUri": null,
> "responseCaching": "Disabled",
> "cacheTimeout": 300,
> "destinationStatsEnabled": false,
> "isDefaultVersion": false,
> "type": "HTTP",
> "transport": [
> "http",
> "https"
> ],
> "tags": [
> "pizza"
> ],
> "tiers": [
> "Unlimited"
> ],
> "maxTps": {
> "sandbox": 5000,
> "production": 1000
> },
> "visibility": "PUBLIC",
> "visibleRoles": [],
> "endpointConfig":
> "{\"production_endpoints\":{\"url\":\"
> https://localhost:9443/am/sample/pizzashack/v1/api/\
> ",\"config\":null},\"sandbox_endpoints\":{\"url\":\"
> https://localhost:9443/am/sample/pizzashack/v1/api/\
> ",\"config\":null},\"endpoint_type\":\"http\"}",
> "endpointSecurity": {
> "username": "user",
> "type": "basic",
> "password": "pass"
> },
> "gatewayEnvironments": "Production and Sandbox",
> "sequences": [],
> "subscriptionAvailability": null,
> "subscriptionAvailableTenants": [],
> "businessInformation": {
> "businessOwnerEmail": "marketing@pizzashack.com",
> "technicalOwnerEmail": "architecture@pizzashack.com",
> "technicalOwner": "John Doe",
> "businessOwner": "Jane Roe"
> },
> "corsConfiguration": {
> "accessControlAllowOrigins": [
> "*"
> ],
> "accessControlAllowHeaders": [
> "authorization",
> "Access-Control-Allow-Origin",
> "Content-Type",
> "SOAPAction"
> ],
> "accessControlAllowMethods": [
> "GET",
> "PUT",
> "POST",
> "DELETE",
> "PATCH",
> "OPTIONS"
> ],
> "accessControlAllowCredentials": false,
> "corsConfigurationEnabled": false
> }
> }
>
> Response:
>
> Error 403 - Forbidden
>
>
> Thank You,
>
> Shiva
>
> _______________________________________________
> Dev mailing list
> Dev@wso2.org
> http://wso2.org/cgi-bin/mailman/listinfo/dev
>
--
*Pasindu Jayaweera *| Senior Software Engineer | WSO2 Inc
Mobile: +94 711555785 | Blog: blog.pasindujayaweera.com
<http://wso2.com/signature>
[Attachment #5 (text/html)]
<div dir="ltr">Hi Shiva,<br><br>As per your message, it seems you are sending a PUT \
request. But to create a new API, you should be sending a <b>POST</b> request. (PUT \
is used to update an existing API) <br>Try with POST request and \
check.<br><br>Regards,</div><br><div class="gmail_quote"><div dir="ltr" \
class="gmail_attr">On Wed, Nov 13, 2019 at 2:58 AM Shiva Kumar <<a \
href="mailto:shiva.k@securelyshare.com">shiva.k@securelyshare.com</a>> \
wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px \
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi Team,<br> <br>
I am following below document and I could not able understand how to <br>
create an API using WSO2 APIM 2.1.0 Publish APIs below is the document I <br>
am following but getting 403 forbidden. Below are the steps I followed.<br>
<br>
1. I created an oauth application from admin console.<br>
<br>
2. I used admin user and it's password to get password grant type token <br>
with scopes apim:api_create, apim:api_view, apim:api_publish.<br>
<br>
3. I used the token obtained from above step and used sample payload <br>
given in document <br>
<a href="https://docs.wso2.com/display/AM210/apidocs/publisher/#!/operations%23APIIndividual%23apisPost" \
rel="noreferrer" target="_blank">https://docs.wso2.com/display/AM210/apidocs/publisher/#!/operations#APIIndividual#apisPost</a> \
<br> to create an API.<br>
<br>
4. Got 403 forbidden response.<br>
<br>
<br>
Request:<br>
<br>
PUT <a href="http://localhost:9773/api/am/publisher/v0.11/apis" rel="noreferrer" \
target="_blank">http://localhost:9773/api/am/publisher/v0.11/apis</a><br> <br>
{<br>
"name": "PizzaShackAPI",<br>
"description": "This document describe a RESTFul API for \
Pizza <br> Shack online pizza delivery store.\r\n",<br>
"context": "/pizzashack",<br>
"version": "1.0.0",<br>
"provider": "admin",<br>
"apiDefinition": <br>
"{\"paths\":{\"/order\":{\"post\":{\"x-auth-type\":\"Application \
& <br> Application <br>
User\",\"x-throttling-tier\":\"Unlimited\",\"description\":\"Create \
a <br> new <br>
Order\",\"parameters\":[{\"schema\":{\"$ref\":\"#/definitions/Order\"},\"description\":\"Order \
<br> object that needs to be <br>
added\",\"name\":\"body\",\"required\":true,\" \
in\":\"body\"}],\"responses\":{\"201\":{\"headers\":{\"Location\":{\"description\":\"The \
<br> URL of the newly created <br>
resource.\",\"type\":\"string\"}},\"schema\":{\&quo \
t;$ref\":\"#/definitions/Order\"},\"description\":\"Crea \
ted.\"}}}},\"/menu\":{\"get\":{\"x-auth-type\":\"Application \
<br> & Application <br>
User\",\"x-throttling-tier\":\"Unlimited\",\"description\":\"Return \
a <br> list of available menu <br>
items\",\"parameters\":[],\"responses\":{\"200\":{\ \
"headers\":{},\"schema\":{\"title\":\"Menu\",\ \
"properties\":{\"list\":{\"items\":{\"$ref\":\ \
"#/definitions/MenuItem\"},\"type\":\"array\"}},\"t \
ype\":\"object\"},\"description\":\"OK.\"}}}}},\&qu \
ot;schemes\":[\"https\"],\"produces\":[\"application/jso \
n\"],\"swagger\":\"2.0\",\"definitions\":{\"MenuItem\":{\"title\":\"Pizza \
<br> menu <br>
Item\",\"properties\":{\"price\":{\"type\":\"s \
tring\"},\"description\":{\"type\":\"string\"},\&qu \
ot;name\":{\"type\":\"string\"},\"image\":{\"t \
ype\":\"string\"}},\"required\":[\"name\"]},\"Order\":{\"title\":\"Pizza \
<br> Order\",\"properties\":{\"customerName\":{\"type\&q \
uot;:\"string\"},\"delivered\":{\"type\":\"boolean\ \
"},\"address\":{\"type\":\"string\"},\"pizzaTy \
pe\":{\"type\":\"string\"},\"creditCardNumber\":{\& \
quot;type\":\"string\"},\"quantity\":{\"type\":\&qu \
ot;number\"},\"orderId\":{\"type\":\"integer\"}},\& \
quot;required\":[\"orderId\"]}},\"consumes\":[\"applicat \
ion/json\"],\"info\":{\"title\":\"PizzaShackAPI\",\"description\":\"This \
<br> document describe a RESTFul API for Pizza Shack online pizza delivery <br>
store.\\n\",\"license\":{\"name\":\"Apache <br>
2.0\",\"url\":\"<a \
href="http://www.apache.org/licenses/LICENSE-2.0.html%5C" rel="noreferrer" \
target="_blank">http://www.apache.org/licenses/LICENSE-2.0.html\</a>"},\"contact\":{\"email\":\"<a \
href="mailto:architecture@pizzashack.com" \
target="_blank">architecture@pizzashack.com</a>\",\"name\":\"John \
<br> Doe\",\"url\":\"<a href="http://www.pizzashack.com" \
rel="noreferrer" target="_blank">http://www.pizzashack.com</a>\"},\"version\":\"1.0.0\"}}",<br>
"wsdlUri": null,<br>
"responseCaching": "Disabled",<br>
"cacheTimeout": 300,<br>
"destinationStatsEnabled": false,<br>
"isDefaultVersion": false,<br>
"type": "HTTP",<br>
"transport": [<br>
"http",<br>
"https"<br>
],<br>
"tags": [<br>
"pizza"<br>
],<br>
"tiers": [<br>
"Unlimited"<br>
],<br>
"maxTps": {<br>
"sandbox": 5000,<br>
"production": 1000<br>
},<br>
"visibility": "PUBLIC",<br>
"visibleRoles": [],<br>
"endpointConfig": <br>
"{\"production_endpoints\":{\"url\":\"<a \
href="https://localhost:9443/am/sample/pizzashack/v1/api/%5C" rel="noreferrer" \
target="_blank">https://localhost:9443/am/sample/pizzashack/v1/api/\</a>",\"config\":null},\"sandbox_endpoints\":{\"url\":\"<a \
href="https://localhost:9443/am/sample/pizzashack/v1/api/%5C" rel="noreferrer" \
target="_blank">https://localhost:9443/am/sample/pizzashack/v1/api/\</a>",\"config\":null},\"endpoint_type\":\"http\"}",<br>
"endpointSecurity": {<br>
"username": "user",<br>
"type": "basic",<br>
"password": "pass"<br>
},<br>
"gatewayEnvironments": "Production and Sandbox",<br>
"sequences": [],<br>
"subscriptionAvailability": null,<br>
"subscriptionAvailableTenants": [],<br>
"businessInformation": {<br>
"businessOwnerEmail": "<a \
href="mailto:marketing@pizzashack.com" \
target="_blank">marketing@pizzashack.com</a>",<br>
"technicalOwnerEmail": "<a \
href="mailto:architecture@pizzashack.com" \
target="_blank">architecture@pizzashack.com</a>",<br> \
"technicalOwner": "John Doe",<br> "businessOwner": \
"Jane Roe"<br> },<br>
"corsConfiguration": {<br>
"accessControlAllowOrigins": [<br>
"*"<br>
],<br>
"accessControlAllowHeaders": [<br>
"authorization",<br>
"Access-Control-Allow-Origin",<br>
"Content-Type",<br>
"SOAPAction"<br>
],<br>
"accessControlAllowMethods": [<br>
"GET",<br>
"PUT",<br>
"POST",<br>
"DELETE",<br>
"PATCH",<br>
"OPTIONS"<br>
],<br>
"accessControlAllowCredentials": false,<br>
"corsConfigurationEnabled": false<br>
}<br>
}<br>
<br>
Response:<br>
<br>
Error 403 - Forbidden<br>
<br>
<br>
Thank You,<br>
<br>
Shiva<br>
<br>
_______________________________________________<br>
Dev mailing list<br>
<a href="mailto:Dev@wso2.org" target="_blank">Dev@wso2.org</a><br>
<a href="http://wso2.org/cgi-bin/mailman/listinfo/dev" rel="noreferrer" \
target="_blank">http://wso2.org/cgi-bin/mailman/listinfo/dev</a><br> \
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" \
class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div \
dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div dir="ltr"><div \
dir="ltr"><div dir="ltr"><b>Pasindu Jayaweera </b>| Senior Software Engineer | WSO2 \
Inc</div><div dir="ltr">Mobile: +94 711555785 | Blog: <a \
href="http://blog.pasindujayaweera.com/" \
target="_blank">blog.pasindujayaweera.com</a></div><div dir="ltr"><div><a \
href="http://wso2.com/signature" target="_blank"><img \
src="http://c.content.wso2.com/signatures/wso2-signature-general.png" width="200" \
height="35"></a></div></div></div></div></div></div></div></div></div></div></div></div></div></div>
_______________________________________________
Dev mailing list
Dev@wso2.org
http://wso2.org/cgi-bin/mailman/listinfo/dev
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic