Our journey with Loopback has been successful thus far, but we are now looking to enhance our API documentation by including query parameters.
In the swagger.json file, there could be a section that resembles this:
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "poc-discovery"
},
"basePath": "/api",
"paths": {
"/Users/{id}/accessTokens/{fk}": {
"get": {
"tags": [
"User"
],
"summary": "Find a related item by id for accessTokens.",
"operationId": "User.prototype.__findById__accessTokens",
"parameters": [
{
"name": "fk",
"in": "path",
"description": "Foreign key for accessTokens",
"required": true,
"type": "string",
"format": "JSON"
},
{
"name": "id",
"in": "path",
"description": "User id",
"required": true,
"type": "string",
"format": "JSON"
},
{
"name":"searchText",
"in":"query",
"description":"The Product that needs to be fetched",
"required":true,
"type":"string"
},
{
"name":"ctrCode",
"in":"query",
"description":"The Product locale needs to be fetched. Example=en-GB, fr-FR, etc.",
"required":true,
"type":"string"
},
],
We believe that the information in the swagger.json is generated dynamically using data from the .json files located in the /server/models directory.
Our goal is to incorporate the query parameters accepted for each model in those .json files without directly modifying the swagger.json. Can you recommend the most effective way to achieve this? We are seeking guidance on how to seamlessly integrate these query parameters into our documentation.