{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This module handles definition of custom REST endpoints via the ","type":"text"},{"text":"Camel REST component","type":"text","marks":[{"type":"link","attrs":{"href":"https://camel.apache.org/manual/latest/rest-dsl.html"}}]},{"text":". ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Description","type":"text"}]},{"type":"paragraph","content":[{"text":"The module allows you to write endpoints directly without having to care about authentication. When the module is enabled and REST endpoints are present, the endpoints are present on a defined context path of IM. The implementation is backed by a servlet which is injected in IM’s (Spring Boot) own servlet, thus sharing the hostname and port with IM. ","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"26a0","text":"⚠","shortName":":warning:"}},{"text":" You cannot use the root or an arbitrary context path – they are reserved. Reserved endpoints are listed in the property ","type":"text"},{"text":"integration.reserved.endpoints","type":"text","marks":[{"type":"code"}]},{"text":" and setting the context path to one of those values will result in a startup failure.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Security","type":"text"}]},{"type":"paragraph","content":[{"text":"Pricefx is used as an authentication provider for all endpoints. You need to provide username/password and partition to log in properly. The partition part is optional – if you do not fill the partition, the default one from the Pricefx connection (if present) will be used.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example of logging into a specific partition:","type":"text"}]},{"type":"codeBlock","content":[{"text":"Username: mvich/integration\nPassword: iAmTheBest\nPricefxConnection: partition=test, url=qa.pricefx.eu/pricefx\n\n--> will perform login into partition mvich under user integration with password iAmTheBest using url \nfrom default pricefx connection (qa.pricefx.eu/pricefx).","type":"text"}]},{"type":"paragraph","content":[{"text":"Example of logging into the base partition:","type":"text"}]},{"type":"codeBlock","content":[{"text":"Username: integration\nPassword: iAmTheBest\nPricefxConnection: partition=test, url=qa.pricefx.eu/pricefx\n\n--> will perform login into default partition test under user integration with password iAmTheBest using url \nfrom default pricefx connection (qa.pricefx.eu/pricefx)","type":"text"}]},{"type":"paragraph","content":[{"text":"The Pricefx connection is not mandatory for this module, but at least URL must be provided.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Properties","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"f7b64a30-c485-4727-bc37-42fab07e51ec"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"Property","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"Default Value","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.enabled","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"If true, the REST module will be embedded into the application.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.binding-mode","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"json","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Sets the binding mode used by the REST consumer.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.component","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"servlet","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Sets the name of the Camel component to use as the REST consumer. Preferred and tested: servlet","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.endpoints.secured","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Determines whether the endpoint shall be secured or not. The user authenticates against the partition. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If false, unauthenticated users are permitted. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If true, the user must be at least authenticated.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.endpoints.path","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"/custom","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"The shared context path of the REST resource.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.endpoints.roles","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"ADMIN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Required role to be able to call the endpoint. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If empty, the user must be authenticated against the partition, but does not have to have any role.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If roles is set, the user must have at least one of the defined roles to access the endpoint.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.doc.secured","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"false","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Determines whether the endpoint shall be secured or not. The user authenticates against the partition.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If false, unauthenticated users are permitted.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If true, the user must be at least authenticated.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.doc.path","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"/api-doc","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"The context path of the documentation (relative to ","type":"text"},{"text":"integration.rest.endpoints.path","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.doc.roles","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Required role to be able to call the endpoint. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If empty, the user must be authenticated against the partition, but does not have to have any role. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If roles is set, the user must have at least one of the defined roles to access the endpoint.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.pretty-print","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Determines whether the data should be pretty-printed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.api-title","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"My API","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Custom title of the API. This will appear in documentation.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[194.0]},"content":[{"type":"paragraph","content":[{"text":"integration.rest.api-version","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[87.0]},"content":[{"type":"paragraph","content":[{"text":"1.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[479.0]},"content":[{"type":"paragraph","content":[{"text":"Custom version of the API. This will appear in documentation.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Examples","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Endpoint Protected, Doc Permitted","type":"text"}]},{"type":"paragraph","content":[{"text":"Create an endpoint which is protected by the role ADMIN and documentation is permitted to all. ","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"9ce9e380-f05c-467b-b908-8d6739917b3a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[255.0]},"content":[{"type":"paragraph","content":[{"text":"Step","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":2,"rowspan":1,"colwidth":[348.0,411.0]},"content":[{"type":"paragraph","content":[{"text":"Manual instance","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"paragraph","content":[{"text":"Provisioned instance","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[255.0]},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create REST endpoint","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[348.0]},"content":[{"type":"paragraph","content":[{"text":"Up to IM 4.9.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[411.0]},"content":[{"type":"paragraph","content":[{"text":"IM 5.0.0 and above","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[348.0]},"content":[{"type":"paragraph","content":[{"text":"In camel-context.xml:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n Creating a program form (rebate agreement) in the Price Fx\n \n \n \n Returns only OK message. Use for validating a login and the service availability.\n \n \n \n def m = [ message:\"OK\" ]\n return m\n \n \n \n \n ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[411.0]},"content":[{"type":"paragraph","content":[{"text":"Declare route:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n def m = [ message:\"OK\" ]\n return m\n \n \n \n ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[582.0]},"content":[{"type":"paragraph","content":[{"text":"Declare route:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n def m = [ message:\"OK\" ]\n return m\n \n \n \n ","type":"text"}]},{"type":"paragraph","content":[{"text":"But this is not enough for api-doc to be generated. You need to declare the following (similarly to how it was in IM version 4.x, but probably not possible in provisioned IM):","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n\n \n\n \n \n \n Bye bye\n \n","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[255.0]},"content":[{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set properties","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":3,"rowspan":1,"colwidth":[348.0,411.0,582.0]},"content":[{"type":"codeBlock","content":[{"text":"integration.rest.enabled=true\nintegration.rest.endpoints.secured=true\nintegration.rest.endpoints.path=/my\nintegration.rest.endpoints.roles=ADMIN\nintegration.rest.doc.secured=false\n...\nintegration.pfx.url=https://qa.pricefx.eu/pricefx\nintegration.pfx.partition=mvich","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[255.0]},"content":[{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Test","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":3,"rowspan":1,"colwidth":[348.0,411.0,582.0]},"content":[{"type":"codeBlock","content":[{"text":"// endpoint accessible by user with role ADMIN\nmst@michal-desktop:~$ curl --request GET https://localhost:8080/my/v1/rebate/ping -k --user im_integration:xxx\n\n{\n \"message\" : \"OK\"\n} \n\n// doc accessible without authentication\nmst@michal-desktop:~$ curl --request GET https://localhost:8080/my/api-doc -k\n\n{\n \"swagger\" : \"2.0\",\n \"info\" : {\n \"version\" : \"1.0\",\n \"title\" : \"My API\"\n },\n \"host\" : \"localhost:8080\",\n \"tags\" : [ {\n \"name\" : \"v1/rebate\",\n \"description\" : \"Creating a program form (rebate agreement) in the Price Fx\"\n } ],\n \"schemes\" : [ \"http\" ],\n \"paths\" : {\n \"/v1/rebate/ping\" : {\n \"get\" : {\n \"tags\" : [ \"v1/rebate\" ],\n \"summary\" : \"Returns only OK message. Use for validating a login and the service availability.\",\n \"operationId\" : \"verb1\",\n \"consumes\" : [ \"application/json\" ],\n \"produces\" : [ \"application/json\" ],\n \"responses\" : {\n \"200\" : { }\n }\n }\n }\n }\n}\n","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Endpoint Protected, Doc Protected","type":"text"}]},{"type":"paragraph","content":[{"text":"Create an endpoint which is protected by a role which the user does not have and the documentation is protected by a role which the user has.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"00b369f4-a8f5-47fe-85be-426c2ae4bec3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[238.0]},"content":[{"type":"paragraph","content":[{"text":"Step","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":2,"rowspan":1,"colwidth":[331.0,376.0]},"content":[{"type":"paragraph","content":[{"text":"Manual instance","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[651.0]},"content":[{"type":"paragraph","content":[{"text":"Provisioned instance","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":2,"colwidth":[238.0]},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create REST endpoint","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[331.0]},"content":[{"type":"paragraph","content":[{"text":"Up to IM 4.9.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"IM 5.0.0 and above","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[651.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[331.0]},"content":[{"type":"paragraph","content":[{"text":"In camel-context.xml:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n Creating a program form (rebate agreement) in the Price Fx\n \n \n \n Returns only OK message. Use for validating a login and the service availability.\n \n \n \n def m = [ message:\"OK\" ]\n return m\n \n \n \n \n ","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[376.0]},"content":[{"type":"paragraph","content":[{"text":"Create following route:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n def m = [ message:\"OK\" ]\n return m\n \n \n \n ","type":"text"}]},{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[651.0]},"content":[{"type":"paragraph","content":[{"text":"Create following route:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n def m = [ message:\"OK\" ]\n return m\n \n \n \n ","type":"text"}]},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[238.0]},"content":[{"type":"orderedList","attrs":{"order":2},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set properties","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[331.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[376.0,651.0]},"content":[{"type":"codeBlock","content":[{"text":"integration.rest.enabled=true\nintegration.rest.endpoints.secured=true\nintegration.rest.endpoints.path=/my\nintegration.rest.endpoints.roles=SOMEROLEiDontHave\nintegration.rest.doc.secured=true\nintegration.rest.doc.path=/api-doc\nintegration.rest.doc.roles=ADMIN\n...\nintegration.pfx.url=https://qa.pricefx.eu/pricefx\nintegration.pfx.partition=mvich","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[238.0]},"content":[{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Test","type":"text"}]}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[331.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":2,"rowspan":1,"colwidth":[376.0,651.0]},"content":[{"type":"codeBlock","content":[{"text":"// doc unavailable if unauthenticated\nmst@michal-desktop:~$ curl --request GET https://localhost:8080/my/api-doc -k\n{\"timestamp\":\"2021-05-11T12:36:08.238+00:00\",\"status\":401,\"error\":\"Unauthorized\",\"message\":\"\",\"path\":\"/my/api-doc\"}\n\n// doc accessible when authenticated and role\nmst@michal-desktop:~$ curl --request GET https://localhost:8080/my/api-doc -k --user im_integration:xxx\n{\n \"swagger\" : \"2.0\",\n \"info\" : {\n \"version\" : \"1.0\",\n \"title\" : \"My API\"\n },\n \"host\" : \"localhost:8080\",\n \"tags\" : [ {\n \"name\" : \"v1/rebate\",\n \"description\" : \"Creating a program form (rebate agreement) in the Price Fx\"\n } ],\n \"schemes\" : [ \"http\" ],\n \"paths\" : {\n \"/v1/rebate/ping\" : {\n \"get\" : {\n \"tags\" : [ \"v1/rebate\" ],\n \"summary\" : \"Returns only OK message. Use for validating a login and the service availability.\",\n \"operationId\" : \"verb1\",\n \"consumes\" : [ \"application/json\" ],\n \"produces\" : [ \"application/json\" ],\n \"responses\" : {\n \"200\" : { }\n }\n }\n }\n }\n}\n\n// endpoint unavailable when user doesn't have the required role\nmst@michal-desktop:~$ curl --request GET https://localhost:8080/my/v1/rebate/ping -k --user im_integration:xxx\n{\"timestamp\":\"2021-05-11T12:38:02.084+00:00\",\"status\":403,\"error\":\"Forbidden\",\"message\":\"\",\"path\":\"/my/v1/rebate/ping\"}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Troubleshooting","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Q: When the app is starting, I get the following error: “Multiple RestConsumerFactory found on classpath. Configure explicit which component to use.”","type":"text"}]},{"type":"paragraph","content":[{"text":"A: You probably have ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" endpoints in context, but ","type":"text"},{"text":"integration.rest.enabled","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". Set the property value to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}],"version":1}

Browser not supported