Apiário:É possível documento que resposta JSON campos são?

Question

Eu gostaria de documento que o real JSON próprios campos representam.

Eu tenho documentado a instrução GET, e os parâmetros, mas isso não faz uma documentação completa para dar aos usuários.

Assim, no exemplo abaixo como posso adicionar um comentário sobre "OtherFields".É este suporte?Ou eu preciso fazer um documento associado a algum outro lugar.

## View Applications [/cat{?sort}{&order}{&page}]
### List all Applications 
### Get List of Applications [GET]
+ Parameters
    + sort (optional, string) ... `sort` parameter is used to specify which criteria to use for sorting. One of the following strings may be used: 
    `"NAME", 
    "RATING", "QUALITY" ,
    "RISKLEVEL", `

    + order (optional, string) ... `order` parameter is used to specify which order to use if sorting is used. One of the following strings may be used: 
    `"ASC", 
    "DESC"`

    + page (optional, int ) ... `page` parameter is used to request subsequent catalog pages.


+ Response 200 (application/json)

                {
            "Catalog" : {
                "Page" : 0,
                "Count" : 6,
                "Applications" : [{
                        "UID" : "6882e96a-5da1-11e3-1111-3f24f45df3ad"
                        "OtherFields: ""
               }]
               }}

Answer 1

Atualização:Temos apenas lançou uma versão beta de atributos descrição usando o MSON sintaxe.

O original de carga pode ser então descrito como

### Get List of Applications [GET]

+ Response 200 (application/json)

    + Attributes
        + Catalog (object)
            + Page: 0 (number) - Number of the page
            + Count: 6 (number) - Count of *Lorem Ipsum*
            + Applications (array) - Some array of something
                + (object)
                    + UID: `6882e96a-5da1-11e3-1111-3f24f45df3ad`
                    + OtherFields

    + Body 

            {
                "Catalog" : {
                    "Page" : 0,
                    "Count" : 6,
                    "Applications" : [{
                        "UID" : "6882e96a-5da1-11e3-1111-3f24f45df3ad"
                        "OtherFields": ""
                    }]
                }
            }

Observação explícita JSON no corpo é redundante e você pode ignorá-lo completamente.Consulte a API do Modelo especificação Atributos para obter detalhes adicionais

Answer 2

Eu acho que não é suportado ainda.

Eu resolvi esse problema no meu projeto, colocando-se uma tabela com a descrição acima, a solicitação GET linha.No seu caso, poderia parecer:

### List all Applications 

| Field                            | Description               |
|----------------------------------|---------------------------|
| Catalog.Applications.OtherFields | Documentation goes here.. |

### Get List of Applications [GET]

Para ajudar você a criar a tabela na sintaxe do Markdown você pode usar Markdown Tabelas gerador de.

Observe que a tabela gerador permite que você salve a definição de tabela para um arquivo de então da próxima vez que você precisa para editar a tabela, você pode começar a partir de onde você parou .