Beppe Catanese ab4a05a959
Postman Collection Generator (#15294)
* Add Postman generator

* Add Postman generator doc

* Remove contact data

* Change license data

* Add Postman in samples

* Add Postman in bin/configs

* Commit changed files

* Update Postman doc

* Correct generator connfiguration

* Regenerate docs

* Correct javadoc

* Use File instead of FileReader

* Rename to postman-collection (schema) generator

* Commit regenerated files

* Improve help and Javadoc

* Commit regenerated files
2023-05-17 00:51:53 +08:00

276 lines
12 KiB
JSON

{
"info": {
"name": "Sample project",
"description": {
"content": "Sample API Check \"API Key\" ",
"type": "text/markdown"
},
"version": "1.0",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "default",
"item": [
{
"name": "/users/{{userId}} (DEPRECATED)",
"description": "Update the information of an existing user.",
"item": [
{
"name": "Update User Information",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "strCode",
"value": "code_one"
},
{
"key": "strCode2",
"value": "null"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"firstName\" : \"Rebecca\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/users/{{userId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"{{userId}}"
],
"variable": [
{
"key": "userId",
"value": "",
"description": "Id of an existing user."
}
],
"query": [
]
},
"description": "Update the information of an existing user."
}
}
]
}
]
},
{
"name": "advanced",
"item": [
{
"name": "/users/{{userId}}",
"description": "Retrieve the information of the user with the matching user ID.",
"item": [
{
"name": "Get User Info by User ID",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "strCode",
"value": "code_one"
},
{
"key": "strCode2",
"value": "null"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/users/{{userId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"{{userId}}"
],
"variable": [
{
"key": "userId",
"value": "",
"description": "Id of an existing user."
}
],
"query": [
]
},
"description": "Retrieve the information of the user with the matching user ID."
}
}
]
}
]
},
{
"name": "basic",
"item": [
{
"name": "/users/",
"description": "Retrieve the information of the user with the matching user ID.",
"item": [
{
"name": "Get User Info by Query Param",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/users/",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"variable": [
],
"query": [
{
"key": "pUserId",
"value": "888"
}
]
},
"description": "Retrieve the information of the user with the matching user ID."
}
}
]
},
{
"name": "/user",
"description": "Create a new user.",
"item": [
{
"name": "Example request for Get User",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\" : 777,\n \"firstName\" : \"Alotta\",\n \"lastName\" : \"Rotta\",\n \"email\" : \"alotta.rotta@gmail.com\",\n \"dateOfBirth\" : \"1997-10-31\",\n \"emailVerified\" : true,\n \"createDate\" : \"2019-08-24\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/user",
"host": [
"{{baseUrl}}"
],
"path": [
"user"
],
"variable": [
],
"query": [
]
},
"description": "Create a new user."
}
}
]
}
]
}
],
"auth": {
"type": "basic",
"basic": [
{
"key": "username",
"value": "{{USERNAME}}",
"type": "string"
},
{
"key": "password",
"value": "{{PASSWORD}}",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "http://localhost:{port}/{version}",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
},
{
"key": "version",
"value": "v1",
"type": "string"
},
{
"key": "port",
"value": "5000",
"type": "string"
},
{
"key": "userId",
"value": "a",
"type": "number"
}
]
}