Sto usando ASP.NET e Swagger che espone un tipo complesso che accetta un POST. Ha un numero di campi stringa con lunghezze diverse. Come posso rifletterlo nell'interfaccia utente di Swagger?Annotazioni dei dati in Swagger
9
A
risposta
12
È possibile annotare le proprietà con StringLengthAttribute
da System.ComponentModel.DataAnnotations
.
Per esempio:
[StringLength(10)]
public String Name {get;set;}
diventerà:
"name": {
"minLength": 0,
"maxLength": 10,
"type": "string"
}
E questo:
[StringLength(10, MinimumLength = 5)]
public String Name {get;set;}
diventa:
"name": {
"minLength": 5,
"maxLength": 10,
"type": "string"
}
Oltre allo StringLength
, lo Swashbuckle supporta anche gli attributi Range
e RegularExpression
.
Aggiornamento
MaxLength
non funziona. StringLength
fa. Tuttavia, scoprire queste informazioni nell'interfaccia utente di Swagger è un po 'goffo. Bisogna passare alla Model
del vostro oggetto e poi il mouse sopra la proprietà:
Problemi correlati
- 1. Come convertire Java Swagger Annotation in Swagger json schema?
- 2. Mostra il valore di esempio XML/JSON nell'interfaccia utente di Swagger utilizzando le annotazioni di swagger
- 3. Annotazioni dei dati sui contratti di servizio della WCF
- 4. C# dati Annotazioni Interfaccia
- 5. Personalizzazione di annotazioni di dati in dati dinamici
- 6. Generazione automatica di annotazioni di dati dai nomi dei campi dei cammelli
- 7. Swagger Tipo di dati Modello in ImplicitParam con Play Framework
- 8. - Annotazioni dati vs InChanging in Entity Framework 4
- 9. Attributo "Visualizza" annotazioni dati MVC 4
- 10. Esiste un buon riferimento per le annotazioni dei dati in merito a come funziona DataType?
- 11. Annotazioni Spring @Autowired all'interno dei metodi
- 12. MVC 4 Annotazioni dati del rasoio ReadOnly
- 13. Ottieni attributi annotazioni dati dal modello
- 14. Limita valore DateTime con annotazioni di dati
- 15. Dati personalizzati Annotazioni con servizi RIA
- 16. Utilizzo di Swagger con WebApi con versione dei nomi
- 17. Accesso ai dati dei dati dei moduli
- 18. Swagger With Static Documentazione
- 19. Come si usa la sezione dei modelli Swagger?
- 20. Dati di rotazione e annotazioni complesse in Django ORM
- 21. Annotazioni dei dati del framework di entità equivalenti a .WillCascadeOnDelete (false);
- 22. Le annotazioni dei dati EF non sono "funzionanti" dopo il targeting .NET 4.5
- 23. swagger-node-express: come caricare il file da swagger-ui?
- 24. Annotazioni dati per la convalida, almeno un campo obbligatorio?
- 25. Come utilizzare le annotazioni dei dati per verificare l'input del tipo particolare
- 26. Spring REST API Documentation using Swagger
- 27. javax validation with swagger & jboss
- 28. localizzare i messaggi dati annotazioni di default ([Required] [StringLength] etc.)
- 29. Rendering di <textarea /> utilizzando annotazioni di dati
- 30. Persistenza dei dati in elm
Grazie. Stavo usando l'attributo MaxLength. Ma nessuno dei due mostra "maxLength": 10 parti nell'interfaccia utente di Swagger. – illug
Sono d'accordo che è un po 'maldestro. Il bit al passaggio del mouse non funziona nemmeno quando hai più di una di queste annotazioni. Si impilano l'uno sull'altro e non si sa a quale campo si riferiscono. Grazie per un'ottima risposta però. – illug
L'ultima versione stabile di 'Swashbuckle' incorpora una nuova versione di' Swagger UI' che corregge le scatole impilate. – venerik