Histórico da Página
Um campo declarado dentro a mensagem deve conter obrigatoriamente as propriedades:
- Type: Indica o tipo do campo, mais detalhes consultar o tópico Tipos de dados padrão.
- Description: é importante que a descrição esteja bem detalhada, lembre-se que para o analista que está propondo um campo, o objetivo deste campo é sempre muito óbvio, porém próximos analistas do mesmo produto ou até analistas de outros produtos sempre terão dificuldade caso o campo não esteja bem documentado.
- x-totvs: propriedade customizada com a documentação referente ao campo em cada produto Totvs.
- Clique aqui para mais detalhes <COLOCAR ANCORA COM O OUTRO DOCUMENTO>
Consulte o tópico Padrão de nomenclatura para mais detalhes sobre a correta redação da documentação dos campos e elaboração de seus nomes.
Padrão de nomenclatura
Os nomes dos campos na mensagem única devem respeitar as regras a seguir:
Devem ser sempre escritos em inglês.
Procure discutir com outras pessoas ou pesquisar no Google Translator a tradução correta dos termos. Deve-se prestar muita atenção na possibilidade de ocorrerem os falsos cognatos.
Exemplo: Código do Turno é ShiftCode e não TurnCode e nem CodeOfTurn. Turn em inglês significa: transformar, voltar, vez e não “turno”, é um caso de falso cognato.
Formatação em Upper Camel Case
Devem respeitar a formatação em Upper CamelCase com a primeira letra maiúscula.
Exemplo |
---|
CustomerCode RegisterDate ListOfItem TypeOfDay |
Padrão para chaves primárias e estrangeiras simples
Ao criar o elemento que representa a chave primária da mensagem utilize apenas a palavra Code, quando for chave simples. Exemplo: na mensagem Seller, use Code e Description/Name.
Exemplo |
---|
Mensagem Item Code Description Status RegisterDate |
Ao utilizar esta chave primária como chave estrangeira em outra mensagem, utilize o padrão “Mensagem” + “Code”, ou seja ItemCode, CustomerCode, BankCode. Exemplo: Na mensagem SalesOrder use SellerCode.
Exemplo |
---|
Mensagem Warehouse Code Description Mensagem Item Code Description Status RegisterDate WarehouseCode |
Reaproveitamento de nomes
Deve-se evitar a utilização de nomes diferentes para campos com o mesmo objetivo, por isso ao criar os nomes de campos para uma mensagem é importante verificar em outras mensagens qual termo está sendo utilizado para o mesmo objetivo.
Exemplo |
---|
Utilizar sempre CompanyId e BranchId para empresa e filial Utilizar sempre ItemCode pois este já é utilizado em todas as mensagens que usam a chave primária da mensagem Item. Não utilizar ProductCode, a mensagem para produto é a Item. Utilizar VendorCode para código do representante e não Suplier e nem Provider, pois a mensagem já existente é CustomerVendor. |
Informações |
---|
Hoje já existe a mensagem Role, que representa Cargo no Logix. O Cargo do Logix corresponde a Função no Protheus. Então novas mensagens propostas pelo Protheus têm que usar o termo Role para Função e não Function. |
Utilize nomes que reflitam a descrição e vice-versa
Exemplo reais e proposta de correção |
---|
TableCodeItem - Código da Tabela de Preços (Deveria ser PriceListCode ou PriceTableCode) SalesPrice - Preço de mínimo de venda do produto (Deveria ser MinimumSalesPrice) |
Tipos dados padrões
Os Tipo de dados seguem as especificações do OpenAPI 3.0.1.
Texto
type: string
Bloco de código | ||
---|---|---|
| ||
"CompanyCode": {
"type": "string"
} |
Propriedades de validação
maxLength | tamanho máximo do texto. Deve ser um valor inteiro maior que 0. |
minLength | tamanho mínimo do texto. Deve ser um valor inteiro maior que 0. |
pattern | string com expressão regular. |
Exemplo | |
---|---|
minLength: 2, | Válido: "22" ; "11" Inválido: "aa" ; "1"; "123" |
Numérico
Inteiro
type: integer
format: int32
Bloco de código | ||
---|---|---|
| ||
"BankCode": {
"description": "Código do banco",
"type": "integer",
"format": "int32"
} |
Long
type: integer
format: int64
Bloco de código | ||
---|---|---|
| ||
"BankCode": {
"description": "Código do banco",
"type": "integer",
"format": "int64"
} |
Float
type: number
format: float
Bloco de código | ||
---|---|---|
| ||
"UnitsPerHour": {
"type": "number",
"format": "float"
} |
Double
type: number
format: double
Bloco de código | ||
---|---|---|
| ||
"CreditLimit":{
"type":"number",
"format":"double"
} |
Propriedades de validação
minimum | menor valor possível para o campo. ex: -9999999.999 |
maximum | maior valor possível para o campo. ex: 9999999.999 |
multipleOf | define que apenas múltiplos a este valor podem ser atribuídos ao campo |
Informações | ||||||
---|---|---|---|---|---|---|
Para definir precisão e escala de números com ponto flutuante, deve-se utilizar essas 3 propriedades.
|
Boleano
type: boolean
Bloco de código | ||
---|---|---|
| ||
"IsPayer":{
"type":"boolean"
} |
Data
type: string
format: date
Bloco de código | ||
---|---|---|
| ||
"Registerdate":{
"type": "string",
"format": "date"
} |
Data e Hora
type: string
format: date-time
Bloco de código | ||
---|---|---|
| ||
"Registerdate":{
"type": "string",
"format": "date-time"
} |
Objeto
type: object
Deve conter o atributo properties, o qual será um objeto com n propriedades.
Bloco de código | ||
---|---|---|
| ||
"CreditInformation": {
"type": "object",
"properties": {
"CreditIndicator": {
"type": "integer",
"format": "int32"
}
}
} |
Para objetos de tipos externos, deve-se utilizar a propriedade $ref, indicando a url do schema desejado, seguido de #/components/schemas/[nome do schema].
Bloco de código | ||
---|---|---|
| ||
"CommunicationInformation": {
"$ref": "http://api.totvs.com.br/schema/ContactInformation_1_000.json#/components/schemas/CommunicationInformationType",
"description": "Informações para Contato",
"type": "object"
} |
Array
type: array
Deve conter o atributo items, o qual deverá conter uma das seguintes opções:
type | Quando array de tipos comuns (string, integer, number, boolean, etc) |
| ||
properties | Quando for array de objetos |
| ||
$ref | Quando array de objetos externos |
|
Nota |
---|
Por definição todo campo ListOf deve ser array. |
Propriedades de validação
minItems | valor mínimo de items do array. |
maxItems | valor máximo de items do array. |
Obrigatoriedade
No yaml as propriedades devem ser definidas como não obrigatórias, pois as mensagens únicas são utilizadas tanto para inclusão quando para exclusão. Ou seja, uma exclusão não precisa enviar tantas informações quanto a inclusão. Se a mensagem única tivesse os seus campos obrigatórios geraria a necessidade de se enviar o registro completo para exclusão e não apenas a sua chave.
Além disso, a obrigatoriedade de um campo depende de cada produto, o que torna muito mais difícil chegar a um consenso se for necessário considerar esta característica na mensagem.
Por isso, ao declarar o schema não se deve inserir a propriedade required:
Campos que se repetem poderão apresentar um padrão diferente, consulte o tópico Criando listas de valores e elementos para mais informações.
Havendo a necessidade de validação da presença ou não de informação na mensagem, este controle deve ser feito no próprio adapter.
Campos de código + descrição
Não é necessário montar mensagens específicas para tabelas que só precisarão trafegar código + descrição. Estas informações poderão trafegar como chave estrangeira na mensagem que as utilizar. Também não é necessário criar agrupadores específicos para estes campos, podem ser colocados na raiz das mensagens.
Exemplo:
Hipoteticamente, a mensagem Item deverá levar a informação do fabricante.
Mensagem Item
Code
Description
ManufacturerCode
ManufacturerDescription
Por exemplo: Não existe a necessidade de criar a mensagem Manufacturer (supondo que contém apenas Código + Descrição). Estes dados deverão ser enviados na mensagem de Item
Âncora | ||||
---|---|---|---|---|
|
Campos com valores fixos devem ser definidos como type: String e seus valores respeitar a sequencia 1,2,3,4 etc... O objetivo desta definição é evitar confusões pelo uso de letras iguais para objetivos diferentes entre os produtos TOTVS. Exemplo: RM Pedido Cancelado = “C”, Datasul Pedido Concluído = “C”. Utilizando sempre a sequência numérica o desenvolvedor se vê obrigado a observar a lista de valores presentes na mensagem, observando inclusive se o tipo que queira utilizar já está listado no YAML
Porém, muitas vezes quando um campo em um produto é composto por uma lista fixa de valores, em outro produto esses valores podem ser cadastrados dinamicamente. Exemplo: Tipo do documento no Logix é fixo, no Protheus é pre-cadastrado e permite alterar, na Datasul é fixo e na RM é totalmente cadastrável. Para estes casos leia o tópico Conflito entre valores fixos e valores cadastráveis.
Bloco de código | ||||
---|---|---|---|---|
| ||||
"SubscriptionType": {
"type": "string",
"example": "pesquisar",
"description": "Unidade de Negócio",
"enum": ["1",
"2",
"3",
"4"],
"x-totvs": [{
"product": "protheus",
"field": "SM0.M0_TPINSC",
"required": false,
"type": "Char",
"length": "1",
"avialable": true,
"canUpdate": false,
"note": "1=CEI;2=CNPJ;3=CPF;4=INCRA"
}]
} |
Referências
https://tools.ietf.org/html/draft-wright-json-schema-validation-00
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#dataTypes