Example apidoc-markdown for issue

readme.md

project-name v0.0.5

Este projeto tem como finalidade ser um guia para novos projetos

• Insured
  • Get Insured

Insured

Get Insured

Back to top

GET /insured

QueryString Parameters

Name	Type	Description
cpf	String	CPF do segurado
email	String	optional E-mail do segurado. Não deve ser informado quando 'origin=backoffice' for informado.
origin	String	optional Local de origem da chamada de API. Deve ser usado o valor 'backoffice' quando a chamada for feita pela interface de atendimento.

Examples

Exemplo de requisição:

curl -i http://localhost:7013/insured?cpf=000000000

Error Response

Erros 400 - Validação de campos

{ "errors": ["CPF não informado", "E-mail não informado"] }

api_data.json

[
  {
    "type": "get",
    "url": "/insured",
    "title": "Get Insured",
    "group": "Insured",
    "name": "GetInsured",
    "parameter": {
      "fields": {
        "QueryString": [
          {
            "group": "QueryString",
            "type": "String",
            "optional": false,
            "field": "cpf",
            "description": "<p>CPF do segurado</p>"
          },
          {
            "group": "QueryString",
            "type": "String",
            "optional": true,
            "field": "email",
            "description": "<p>E-mail do segurado. Não deve ser informado quando 'origin=backoffice' for informado.</p>"
          },
          {
            "group": "QueryString",
            "type": "String",
            "optional": true,
            "field": "origin",
            "description": "<p>Local de origem da chamada de API. Deve ser usado o valor 'backoffice' quando a chamada for feita pela interface de atendimento.</p>"
          }
        ]
      }
    },
    "examples": [
      {
        "title": "Exemplo de requisição:",
        "content": "curl -i http://localhost:7013/insured?cpf=000000000",
        "type": "curl"
      }
    ],
    "error": {
      "fields": {
        "Error 4xx": [
          {
            "group": "Error 4xx",
            "optional": false,
            "field": "400",
            "description": "<p>CPF não informado</p>"
          }
        ]
      },
      "examples": [
        {
          "title": "Erros 400 - Validação de campos",
          "content": "{ \"errors\": [\"CPF não informado\", \"E-mail não informado\"] }",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "lib/insured/insured-routes.js",
    "groupTitle": "Insured"
  }
]

api_project.json

{
  "name": "project-name",
  "version": "0.0.5",
  "description": "Este projeto tem como finalidade ser um guia para novos projetos",
  "sampleUrl": false,
  "defaultVersion": "0.0.0",
  "apidoc": "0.3.0",
  "generator": {
    "name": "apidoc",
    "time": "2020-01-13T18:03:16.668Z",
    "url": "http://apidocjs.com",
    "version": "0.19.1"
  }
}