Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 24.0
Div
Classe2e-refDiv

Otp
Floatingfalse

Rp

You can import an OpenAPI file describing a REST interface directly from a file or via a URL. The importer will generate all necessary interface elements to your UML model to use this REST service with the REST Adapter.

Info
iconfalse

At the moment, the import of OpenAPI 3 specifications is not supported. You can use a tool to convert OpenAPI 3 into OpenAPI 2 and then import the result. A useful tool for this is https://www.npmjs.com/package/api-spec-converter. You can find more tools at https://openapi.tools/. 

The OpenAPI import rules are described in detail in REST Import Rules.

To import an OpenAPI for REST, select Import > OpenAPI from the Model Compiler menu.

Image Modified

Enter a file location or an URL. By clicking Image Modified, you can use the File Chooser to lookup the file.

Note the following for Bridge REST services:
You can get the URL to the OpenAPI file from the Bridge as described on xUML Service Details (see REST service Interface). Copy the link location or download the file.

Click OK.

Image Modified

The selected OpenAPI file can be imported into either an existing or a new UML model.
If you choose to import to a new model, the REST Importer will import the OpenAPI file to a generated simple test model you can easily test all imported REST resources with.

Click OK to import the definitions. You can still cancel the import by clicking Cancel.

The importer generates the interface definitions to a new repository package having the name of the import file.

Image Modified

Note
iconfalse

Creation of aliases and alias templates: During the first import into an existing model, aliases and alias templates are created. When a file is re-imported, the alias templates are changed and missing aliases are recreated. Existing aliases remain unchanged in this case. While importing into a new model, aliases and alias templates are created.

Import Problems

Multiexcerpt include
MultiExcerptNameimport_problems
PageWithExcerptREST Adapter

Panel
titleOn this Page:
Table of Contents
Panel
titleRelated Pages: