Skip to content

CreatingMockServer.md

Latest commit

 

History

History
81 lines (59 loc) · 3.98 KB

CreatingMockServer.md

File metadata and controls

81 lines (59 loc) · 3.98 KB

Creating a Mock Server from the OAS

Prerequisite: OAS has been defined in VSCode.

Create the API from the OAS

Open your local Postman installation.
Change to workspace "MW_SDN_Applications".
(If the workspace does not appear in your Postman, send an email to: Thorsten.Heinze@telefonica.com to gain access.)
Workspace

The workspace already contains various APIs of other applications. (In subsequent screenshots they are not visible, as the captures were taken in a test workspace.)
Workspace_Content

Click the APIs folder at the very left of the Postman window.
Click the "+" for creating a new API.
Create_API

Enter the official application name as a Name of the API definition.
Enter_API_name

Enter a low version number like e.g. 0.0.1 (you will be able to adapt the version number at any time).
Define Schema type to be "OpenAPI 3.0" and Schema format to be "YAML" and create the API.
Select_API_type

After the API has been created, click on the just created version.
API_after_creation

Click on "Definition".
Click into the Postman editor, CTRL+a, delete all default content from the index file.
Open your OAS in the VSCode editor, click into the editor, CTRL+a, CTRL+c. Change into the Postman editor, CTRL+v, CTRL+s.
Add_own_app_oas

Generate a collection and mock server

Click "Add collection", then "Generate from definition".
Generate_collection

Name your collection according to your application's name. Leave the parameters as they are.
Select_collection_name

This will create a collection folder under APIs.
Example_collection

Now also create a collection under the Collections tab.
Under APIs navigate to your previously generated collection and select "Copy to collections".
Copy_collection

Wait until your collection has been created under Collections.
Copied_collection

Create the mock server via the "..." menu and selecting "Mock collection".
Mock_collection

Enter your application's name as name for the mock server. Keep the preset options.
Mock_server_name

Copy the mock url and paste into some editor for later usage.
mock_server_url

Go back to the Collections tab and select your collection. On the left side click on the Variables tab to display the collection variables.
collection_variables

Search for the "baseUrl" variable, paste to mock server url into the "CurrentValue" field and save your configuration via CTRL+s. baseUrl

Before testing can be started, make sure to fix problems in your collection:

  • e.g. (duplicate) variables may have been created, which need to be cleaned-up
  • also check your individual services and OaM paths for correct RequestBodies
  • requests may also have query parameters, which would have to be set sufficiently in the "Params" tab of the respective request. query_parameter

Executing an request against the mock server:

  • If you push "Send" on an example request, the newly created mock server will answer.
  • It is a matter of coincidence, which status code the mock server answers, but if you would expand the list of answers for the request, you could find the 200 or 204 as the top-level entry in the list.
  • Here you could check the ResponseBodies of the successfully processed requests.
  • Actually, you just see the examples you defined in the OAS.
  • If you would not find the expected attributes, you most likely entered an example that is contradicting the structure or format definitions.

The picture shows an example response:
request_example