Composition API | Getting Started?

Hi there,

after creating a new solution, compiling and running it on the Self-hosted API server, I expected to be able to call the standard QBM_ApiServerAdmin or QBM_OperationsSupport resources. Although the Start point http://localhost:8182/ works, all my shoots to find the standard projects delivered 404.

I also tried a custom project with the sames results.

How are the resulting resources structured? Is it possible to have an overview? Where is the Postman and Swagger OpenAPI implementation mentioned in the documentation?

How can I see which API is currently running (from Project File vs Database)?

When working on a project, where do I see which compilation branch is currently being modified?

Thank you in advance

Parents
  • Hi Jose,

    Open a browser on http://localhost:8182/swagger/ui/index.html?url=/swagger/swagger.json to access the built-in Swagger UI. You can use that to test basic functionality of the API server.

    Postman is a seperate tool, not included in Identity Manager, that you can use to make calls to the API server. On the Modules\QBM\dvd\AddOn\ApiSamples\Sdk06_ClientJson folder of the installation set, you will find a JSON file that you can import into Postman to make some sample requests.

    The distinction of "Project file" vs. "database" API definitions is purely a compile-time setting, and there is currently no way to tell at runtime which setting was active at compile time.

    The compilation branch setting is only relevant when reading/writing a compiled API DLL from/to the database.

    Hope this helps,
    Hanno

Reply
  • Hi Jose,

    Open a browser on http://localhost:8182/swagger/ui/index.html?url=/swagger/swagger.json to access the built-in Swagger UI. You can use that to test basic functionality of the API server.

    Postman is a seperate tool, not included in Identity Manager, that you can use to make calls to the API server. On the Modules\QBM\dvd\AddOn\ApiSamples\Sdk06_ClientJson folder of the installation set, you will find a JSON file that you can import into Postman to make some sample requests.

    The distinction of "Project file" vs. "database" API definitions is purely a compile-time setting, and there is currently no way to tell at runtime which setting was active at compile time.

    The compilation branch setting is only relevant when reading/writing a compiled API DLL from/to the database.

    Hope this helps,
    Hanno

Children