Manage versioned API in Azure API Manager

Question

I´m looking into host our web API in Azure using an API app. I am using the Azure API Manager in front of the API App to expose the developer portal to some of our consumers. The web API is built in .NET core and it has version support using the URL (https://example.com/api/v2/controller...). I have given it swagger support and one swagger.json is created for each version. These swagger files I use in my ARM templates to set up API Manager and expose this versioned API. When adding a version to API Manager I have to give a path which must be unique for the API Im adding. So for version v1 I give "api/v1" and for v2 I give "api/v2". So far so good. The problem is when trying to call the API using API Manager the URL ends up to be: https://foo-api-manager-dev.azure-api.net/api/v2/api/v2/tests So the "api/v2"-part i duplicated. I guess it has something to do with how API Manager works and how my versioning is set up in my web API. When calling the controllers directly to the API App then the URL is correct.

I have searched around a lot and tried different approaches to this but could really need some input here. All suggestions are appreciated!

My routing is managed in a base controller and looks like this

[Produces("application/json")]
[Route("api/v{version:apiVersion}/[controller]")]
public abstract class VersionBaseController : ApiController
{
    protected VersionBaseController()
       : base()
    {
    }
}

Controllers like this:

[ApiVersion("2.0")]
public class TestsController : VersionBaseController
{
    [HttpGet]
    public string Get()
    {
        return "Get works V2";
    }

The entire template to create the api manager:

//Create API Manager
{
  "apiVersion": "2018-06-01-preview",
  "name": "[parameters('apim_name')]",
  "location": "[parameters('location')]",
  "type": "Microsoft.ApiManagement/service",
  "sku": {
    "name": "[parameters('apim_tier')]",
    "capacity": 1
  },
  "properties": {
    "publisherEmail": "[parameters('apim_adminEmail')]",
    "publisherName": "[parameters('apim_orgName')]"
  },
  "resources": [
    //Create version set
    {
      "apiVersion": "2017-03-01",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "[concat(parameters('apim_name'), '/', parameters('VersionSetName'))]",
      "dependsOn": [
        "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'))]"
      ],
      "properties": {
        "description": "Version configuration",
        "displayName": "Api set 1",
        "versioningScheme": "Segment"
      }
    },
    //Link version 1
    {
      "apiVersion": "2017-03-01",
      "type": "apis",
      "name": "AvidaAPIV1",
      "dependsOn": [
        "[resourceId('Microsoft.ApiManagement/service/api-version-sets', parameters('apim_name'), parameters('VersionSetName'))]",
        "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'))]"
      ],
      "properties": {
        "contentFormat": "swagger-link-json",
        "contentValue": "[concat(parameters('ExternalApiBaseUrl'),'/swagger/v1/swagger.json')]",
        "path": "/api/v1",
        "isCurrent": true,
        "apiVersion": "v1",
        "apiVersionName": "v1",
        "apiVersionDescription": "string",
        "apiVersionSetId": "[concat('Microsoft.ApiManagement/service/api-version-sets', parameters('VersionSetName'))]"
      }
    },
    //Link version 2
    {
      "apiVersion": "2017-03-01",
      "type": "apis",
      "name": "AvidaAPIV2",
      "dependsOn": [
        "[resourceId('Microsoft.ApiManagement/service/api-version-sets', parameters('apim_name'), parameters('VersionSetName'))]",
        "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'))]"
      ],
      "properties": {
        "contentFormat": "swagger-link-json",
        "contentValue": "[concat(parameters('ExternalApiBaseUrl'),'/swagger/v2/swagger.json')]",
        "path": "/api/v2",
        "isCurrent": false,
        "apiVersion": "v2",
        "apiVersionName": "v2",
        "apiVersionDescription": "string",
        "apiVersionSetId": "[concat('Microsoft.ApiManagement/service/api-version-sets', parameters('VersionSetName'))]"
      }
    },
    //Create unlimited product
    {
      "apiVersion": "2017-03-01",
      "type": "products",
      "name": "[concat('UnlimitedProduct', parameters('ProductNameSuffix'))]",
      "dependsOn": [
        "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'))]"
      ],
      "properties": {
        "displayName": "[concat('UnlimitedProduct', parameters('ProductNameSuffix'))]",
        "description": "Unlimited external access",
        "terms": "",
        "subscriptionRequired": false,
        "state": "published"
      },
      "resources": [
        {
          "apiVersion": "2017-03-01",
          "type": "apis",
          "name": "AvidaAPIV1",
          "dependsOn": [
            "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'))]",
            "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'), '/apis/AvidaAPIV1')]",
            //"[concat('Microsoft.ApiManagement/service/', parameters('apim_name'), '/apis/AvidaAPIV2')]",
            "[concat('Microsoft.ApiManagement/service/', parameters('apim_name'), '/products/UnlimitedProduct', parameters('ProductNameSuffix'))]"
          ]
        }
      ]
    }

score 0 · Answer 1 · answered Jul 09 '18 at 17:24

It depends on how you configure your version set. Initially each API in Azure APIM has only URI suffix - i.e. part of the path coming right after host to identify API called. When you add API to a version set and set this version set's scheme to "path" you additionally specify version string for each API. look into your API's settings, there should be a field called "Version identified". This identifier is appended to API URL suffix automatically.

So imagine you have an API with suffix of "httpbin" and you add it to a version set and set it's version identified to "v0" that means that this API will be reachable by calling https://xxx.xxx/httpbin/v0/...

Looking at your configuration. I have a feeling that you've put "api/v1" as both API suffix and version identifier. Try splitting it into "api" as API suffix, and "v1" as version identifier.

Its a good thought actually. I checked it and realized that my version set is not created at all. Something is wrong with my template I think — Nicklas Cederholm, Jul 11 '18 at 17:36

score 0 · Answer 2 · answered Jul 10 '18 at 10:25

0

To be able to identify the issue, it would be helpful to have the api-part of the automation script. In that way we can see what APIM actually uses as ARM template regarding the linked version 1 and 2 of the APIs.

answered Jul 10 '18 at 10:25

Jean-Paul Smit

300
4
17

I´m not sure what you mean with the "api-part" but I edited my initial question and provided the entire template for the api-manager... – Nicklas Cederholm Jul 11 '18 at 18:14

score 0 · Answer 3 · answered Jul 11 '18 at 17:51

0

So I realized in APIM there is no version set created at all: The resulting APIs from my above template scripts

I then created version set manually and linked to my 2 swaggers in the Azure portal and then it looks correct: Manually created in portal

But even when creating the version manually I have the same problem with the URL. I need to duplicate "api/v2/api/v2/[controller]"

The settings for version2 now looks like this which seems correct to me: enter image description here

answered Jul 11 '18 at 17:51

Nicklas Cederholm

31
3

Hello. Did you ever solve this? I’m getting the exact same thing. I’ve tried so many different ways of doing it but I end up in the exact same scenario as you. Thanks! – Chris.ZA Oct 12 '18 at 16:56

Manage versioned API in Azure API Manager

3 Answers3

Linked