AppApiEndpoint class final

Um endpoint documentado.

Annotations

Constructors

AppApiEndpoint({required AppApiMethod method, required String path, String? summary, String? description, List<String> tags = const <String>[], bool requiresAuth = true, List<AppApiParam> params = const <AppApiParam>[], List<AppApiField> requestFields = const <AppApiField>[], String? requestExampleJson, List<AppApiResponse> responses = const <AppApiResponse>[], String? curl, String? notes})
Cria um AppApiEndpoint.
const

Properties

curl → String?
Comando curl pronto para colar. Nunca deve conter credencial real.
final
description → String?
Descrição longa, quando a especificação traz.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
Chave estável do endpoint — MÉTODO path. O Swagger da Tracked não emite operationId, então o par verbo+path é o identificador disponível.
no setter
method → AppApiMethod
Verbo HTTP.
final
notes → String?
Observação da própria aplicação (regra de negócio, pegadinha conhecida).
final
params → List<AppApiParam>
Parâmetros de path/query/header/form.
final
path → String
Path com os placeholders da especificação (/devices/{id}).
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
requestExampleJson → String?
Exemplo de corpo da requisição, já formatado.
final
requestFields → List<AppApiField>
Schema do corpo da requisição.
final
requiresAuth → bool
Se exige token de autenticação.
final
responses → List<AppApiResponse>
Respostas possíveis, na ordem em que devem aparecer.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
summary → String?
Resumo de uma linha.
final
tags → List<String>
Tags da especificação (Devices, Associations…).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
paramsIn(AppApiParamLocation location) → List<AppApiParam>
Parâmetros filtrados por onde viajam.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited