[Spike] API Connect / LoopBack 4 integration

[dhmlau]

Suggestion

APIConnect v2018 now has limited support in OpenAPIv3. See demo and limitations.

Use Cases

There might be various use cases, I think for one use case, we can:

1. create LoopBack 4 application and expose some REST APIs
2. Using APIConnect cli, import existing OpenAPI from step 1. (From my understanding, there is no UI support for OpenAPIv3, so need to do it through CLI)
3. Once the API has been imported, change the target-url to point to that REST API endpoint
4. publish to catalog
5. set up portal
6. test it within portal

Note: this is based on my limited understanding of APIConnect and things might change as well. We can get @smartmouse to help if needed.

Acceptance criteria

We should:

• Import OpenAPI v3 spec from a LoopBack 4 API into IBM APIConnect
• Try to create subscriptions for the API from IBM Advanced Portal
• Test the LB endpoint from IBM APIConnect after importing
• investigate if General limitations and Security limitations in APIC Knowledge Center would affect us

cc @raymondfeng @bajtos @deepakrkris

[jannyHou]

• LB provide security def + api def + additional policies.
• Make sure apic could manage the apis exposed by lb4.
• APIC supports oauth 2, make sure the spec created by lb4 is consumable by apic.
• Feature: gateway enforce some policies and passes context to LB4 app.

[deepakrkris]

I tried importing the api spec from the LoopBack todo example app to apic and had the following errors:

DEEPAKs-MacBook-Pro:~ deepakrajamohan$ ./apic-slim products:publish --scope catalog --server admin11.loki.dev.ciondemand.com  --org ibm --catalog sandbox --mode apim  todo.yaml
Error: The multipart 'openapi' field contains an OpenAPI definition (unnamed):1.0.0 (todolist24) that has validation errors.
  - Additional property /todo-lists is not allowed (context: (root).paths, line: 518, col: 24)
Additional property /todo-lists/{id} is not allowed (context: (root).paths, line: 336, col: 29)
Additional property /todos is not allowed (context: (root).paths, line: 968, col: 19)
Additional property /todos/{id} is not allowed (context: (root).paths, line: 747, col: 24)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.NewTodo, line: 1341, col: 24)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.NewTodo.additionalProperties, line: 1361, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.NewTodoInTodoList, line: 1247, col: 34)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.NewTodoInTodoList.additionalProperties, line: 1267, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.NewTodoList, line: 1309, col: 28)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.NewTodoList.additionalProperties, line: 1323, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.Todo, line: 1223, col: 21)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.Todo.additionalProperties, line: 1245, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoList, line: 1291, col: 25)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoList.additionalProperties, line: 1307, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListImage, line: 1127, col: 30)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListImage.additionalProperties, line: 1143, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListImageWithRelations, line: 1201, col: 43)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListImageWithRelations.additionalProperties, line: 1221, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListPartial, line: 1325, col: 32)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListPartial.additionalProperties, line: 1339, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListWithRelations, line: 1173, col: 38)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoListWithRelations.additionalProperties, line: 1199, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoPartial, line: 1269, col: 28)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoPartial.additionalProperties, line: 1289, col: 41)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoWithRelations, line: 1145, col: 34)
Must validate one and only one schema (oneOf) (context: (root).components.schemas.TodoWithRelations.additionalProperties, line: 1171, col: 41)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0, line: 617, col: 21)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema, line: 622, col: 35)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.additionalProperties, line: 708, col: 53)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.properties, line: 624, col: 43)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.properties.items, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.properties.items.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists.get.parameters.0.schema.properties.items.properties.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1, line: 397, col: 21)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema, line: 402, col: 35)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.additionalProperties, line: 488, col: 53)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties, line: 404, col: 43)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0, line: 1020, col: 21)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema, line: 1025, col: 35)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.additionalProperties, line: 1117, col: 53)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.properties, line: 1027, col: 43)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.properties.items, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.properties.items.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos.get.parameters.0.schema.properties.items.properties.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1, line: 841, col: 21)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema, line: 846, col: 35)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.additionalProperties, line: 938, col: 53)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties, line: 848, col: 43)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties.properties, line: 0, col: 0)
Property "NewTodo" does not match pattern <no value> (context: (root).components.schemas, line: 1341, col: 24)
Property "NewTodoInTodoList" does not match pattern <no value> (context: (root).components.schemas, line: 1247, col: 34)
Property "NewTodoList" does not match pattern <no value> (context: (root).components.schemas, line: 1309, col: 28)
Property "Todo" does not match pattern <no value> (context: (root).components.schemas, line: 1223, col: 21)
Property "TodoList" does not match pattern <no value> (context: (root).components.schemas, line: 1291, col: 25)
Property "TodoListImage" does not match pattern <no value> (context: (root).components.schemas, line: 1127, col: 30)
Property "TodoListImageWithRelations" does not match pattern <no value> (context: (root).components.schemas, line: 1201, col: 43)
Property "TodoListPartial" does not match pattern <no value> (context: (root).components.schemas, line: 1325, col: 32)
Property "TodoListWithRelations" does not match pattern <no value> (context: (root).components.schemas, line: 1173, col: 38)
Property "TodoPartial" does not match pattern <no value> (context: (root).components.schemas, line: 1269, col: 28)
Property "TodoWithRelations" does not match pattern <no value> (context: (root).components.schemas, line: 1145, col: 34)
components.schemas.NewTodo.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.NewTodo.additionalProperties, line: 1361, col: 41)
components.schemas.NewTodoInTodoList.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.NewTodoInTodoList.additionalProperties, line: 1267, col: 41)
components.schemas.NewTodoList.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.NewTodoList.additionalProperties, line: 1323, col: 41)
components.schemas.Todo.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.Todo.additionalProperties, line: 1245, col: 41)
components.schemas.TodoList.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoList.additionalProperties, line: 1307, col: 41)
components.schemas.TodoListImage.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoListImage.additionalProperties, line: 1143, col: 41)
components.schemas.TodoListImageWithRelations.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoListImageWithRelations.additionalProperties, line: 1221, col: 41)
components.schemas.TodoListPartial.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoListPartial.additionalProperties, line: 1339, col: 41)
components.schemas.TodoListWithRelations.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoListWithRelations.additionalProperties, line: 1199, col: 41)
components.schemas.TodoPartial.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoPartial.additionalProperties, line: 1289, col: 41)
components.schemas.TodoWithRelations.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).components.schemas.TodoWithRelations.additionalProperties, line: 1171, col: 41)
paths./todo-lists.get.parameters.0.schema.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todo-lists.get.parameters.0.schema.additionalProperties, line: 708, col: 53)
paths./todo-lists.get.parameters.0.schema.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todo-lists.get.parameters.0.schema.properties.additionalProperties, line: 0, col: 0)
paths./todo-lists.get.parameters.0.schema.properties.items.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todo-lists.get.parameters.0.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
paths./todo-lists.get.parameters.0.schema.properties.items.properties.properties.properties is of incorrect type. Expected: object, Given: null (context: (root).paths./todo-lists.get.parameters.0.schema.properties.items.properties.properties.properties, line: 0, col: 0)
paths./todo-lists/{id}.get.parameters.1.schema.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.additionalProperties, line: 488, col: 53)
paths./todo-lists/{id}.get.parameters.1.schema.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.additionalProperties, line: 0, col: 0)
paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.properties.properties is of incorrect type. Expected: object, Given: null (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.properties.properties, line: 0, col: 0)
paths./todos.get.parameters.0.schema.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todos.get.parameters.0.schema.additionalProperties, line: 1117, col: 53)
paths./todos.get.parameters.0.schema.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todos.get.parameters.0.schema.properties.additionalProperties, line: 0, col: 0)
paths./todos.get.parameters.0.schema.properties.items.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todos.get.parameters.0.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
paths./todos.get.parameters.0.schema.properties.items.properties.properties.properties is of incorrect type. Expected: object, Given: null (context: (root).paths./todos.get.parameters.0.schema.properties.items.properties.properties.properties, line: 0, col: 0)
paths./todos/{id}.get.parameters.1.schema.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todos/{id}.get.parameters.1.schema.additionalProperties, line: 938, col: 53)
paths./todos/{id}.get.parameters.1.schema.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.additionalProperties, line: 0, col: 0)
paths./todos/{id}.get.parameters.1.schema.properties.items.properties.additionalProperties is of incorrect type. Expected: object, Given: string (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties.additionalProperties, line: 0, col: 0)
paths./todos/{id}.get.parameters.1.schema.properties.items.properties.properties.properties is of incorrect type. Expected: object, Given: null (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties.properties.properties, line: 0, col: 0)
DEEPAKs-MacBook-Pro:~ deepakrajamohan$ 

[deepakrkris]

I was able to import a converted YAML file from the Loopback api JSON spec into APIC.
The biggest challenge was to get a well formatted YAML. I also did a few modifications as below:

1 - added a x-ibm-configuration section in the top below the api info section

x-ibm-configuration:
 assembly:
   execute:
   - invoke:
       title: invoke
       version: 2.0.0
       target-url: 'http://apicsrv01.dp.rtp.raleigh.ibm.com/sample.json'
 cors:
   enabled: true
 enforced: true
 phase: realized
 testable: true
 gateway: datapower-api-gateway  

2 - changed the info section as below. Original LoopBack spec has capital letters for title which apic complains about. Also added x-ibm-name

info:
  x-ibm-name: todolist24
  version: 1.0.0
  title: todolist24
  license:
    name: MIT

3 - the below scope section in all filter object definition creates errors when importing to apic. So I have removed it for time being.

UPDATE: I checked by importing the openapi file in JSON format (as downloaded directly from LB app) to apic and the above error does not occur. Error occurs only for converted YAML format.

                  scope: 
                    properties: 
                      where: 
                        type: "object"
                        additionalProperties: false
                      fields: 
                        type: "object"
                        properties: 
                        additionalProperties: false
                      offset: 
                        type: "integer"
                        minimum: 0
                      limit: 
                        type: "integer"
                        minimum: 1
                        example: "100"
                      skip: 
                        type: "integer"
                        minimum: 0
                      order: 
                        type: "array"
                        items: 
                          type: "string"
                    additionalProperties: false

[deepakrkris]

Without removing the scope section in the filter object definition the following errors are thrown while importing to APIC. I am investigating the root cause.

UPDATE: I checked by importing the openapi file in JSON format (as downloaded directly from LB app) to apic and the above error does not occur. Error occurs only for converted YAML format.

DEEPAKs-MacBook-Pro:~ deepakrajamohan$ ./apic-slim products:publish --scope catalog --server admin11.loki.dev.ciondemand.com  --org ibm --catalog sandbox --mode apim  todo.yaml
Error: The multipart 'openapi' field contains an OpenAPI definition (unnamed):1.0.0 (todolist24) that has validation errors.
  - Additional property /todo-lists/{id} is not allowed (context: (root).paths, line: 336, col: 29)
Additional property /todos/{id} is not allowed (context: (root).paths, line: 714, col: 24)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1, line: 397, col: 21)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema, line: 402, col: 35)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties, line: 404, col: 43)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1, line: 808, col: 21)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema, line: 813, col: 35)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties, line: 815, col: 43)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties, line: 0, col: 0)
Must validate one and only one schema (oneOf) (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties.properties, line: 0, col: 0)
paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.properties.properties is of incorrect type. Expected: object, Given: null (context: (root).paths./todo-lists/{id}.get.parameters.1.schema.properties.items.properties.properties.properties, line: 0, col: 0)
paths./todos/{id}.get.parameters.1.schema.properties.items.properties.properties.properties is of incorrect type. Expected: object, Given: null (context: (root).paths./todos/{id}.get.parameters.1.schema.properties.items.properties.properties.properties, line: 0, col: 0)

[deepakrkris]

So far I have imported the following YAML into APIC after making the above changes. I will have to test the LoopBack endpoint and confirm if the import was all good.

todolist-apispec.yaml.txt

[deepakrkris]

I am able to check all the api endpoints from IBM Portal

[deepakrkris]

IBM Advanced Portal is able to digest all information from the uploaded api spec of the LoopBack app.

[deepakrkris]

I am able to subscribe to the ToDo API product from the IBM Portal.

[dhmlau]

@deepakrkris, the error you listed in #4115 (comment), did LB generate a valid OpenAPI spec (I thought we do) or it's some validation inside APIC? Thanks.