HOW-TO Find the Swagger API file for a Service

Version Date Sign Description

0.9 2018-02-07 MO

1.0 2019-04-10 MO Editorial updates

Swagger file in JSON

The Swagger file contains ”all” static details of a REST service

The Swagger file for a SeaSWIM service is found through Service Registry in the Service Design section.

The Service Design can be retrieved via the Service Instance or Service Specification, if not searched directly in design section.

Swagger file in JSONFind the swagger file for a certain service instance.

• Login to MC Portal– https://test-management.maritimecloud.net/

– https://staging-management.maritimecloud.net

– https://management.maritimecloud.net/

• Select desired Instances from Service Registry

• Search and select the service instance on focus

• Press the link to ”Implemented design” and the Service Technical Design will be selected

– Download XML

• To get the Service Design as XML

• In the element <model> you can find the Swagger in JSON (or a link) !

– Download Document

• To get the description of the Service Design, including the swagger

Swagger file in JSONFind the swagger file for a certain technical design for a service specification

• Login to MC Portal– https://test-management.maritimecloud.net/

– https://staging-management.maritimecloud.net

– https://management.maritimecloud.net/

• Select desired Specification from Service Registry

• Select desired Design

– Download XML

• To get the Service Design as XML

• In the element <model> you can find the Swagger in JSON !

– Download Document

• To get the description of the Service Design

Snapshot from MC TEST Portal

Swagger in the Service Design as XML

<servicePhysicalDataModel><name>Voyage Information Service SMA Swagger JSON

API</name><description>API of VIS in JSON format</description><modelType>JSON</modelType><model>

{"swagger": "2.0","info": {

"version": "2.2.0","title": "STM Voyage Information Service SeaSWIM API","description": "2.2.0"

},……..