GitHub-Mirror/huma
2
0
Fork 0
mirror of https://github.com/Fishwaldo/huma.git synced 2025-03-17 12:21:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: minor layout change for example code

Browse source
This commit is contained in:
Daniel G. Taylor 2020-04-03 23:40:49 -07:00
parent 393ebfedd8
commit 0b16d0eddb
No known key found for this signature in database
GPG key ID: 7BD6DC99C9A87E22
2 changed files with 36 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -93,22 +93,20 @@ func main() {
})
notes := r.Resource("/notes")
notes.List("Returns a list of all notes",
func() []*NoteSummary {
// Create a list of summaries from all the notes.
summaries := make([]*NoteSummary, 0)
notes.List("Returns a list of all notes", func() []*NoteSummary {
// Create a list of summaries from all the notes.
summaries := make([]*NoteSummary, 0)
memoryDB.Range(func(k, v interface{}) bool {
summaries = append(summaries, &NoteSummary{
ID: k.(string),
Created: v.(*Note).Created,
})
return true
memoryDB.Range(func(k, v interface{}) bool {
summaries = append(summaries, &NoteSummary{
ID: k.(string),
Created: v.(*Note).Created,
})
return true
})
return summaries
},
)
return summaries
})
// Add an `id` path parameter to create a note resource.
note := notes.With(huma.PathParam("id", "Note ID", &huma.Schema{
@ -117,16 +115,14 @@ func main() {
notFound := huma.ResponseError(http.StatusNotFound, "Note not found")
note.Put("Create or update a note",
func(id string, n *Note) bool {
// Set the created time to now and then save the note in the DB.
n.Created = time.Now()
memoryDB.Store(id, n)
note.Put("Create or update a note", func(id string, n *Note) bool {
// Set the created time to now and then save the note in the DB.
n.Created = time.Now()
memoryDB.Store(id, n)
// Empty responses don't have a body, so you can just return `true`.
return true
},
)
// Empty responses don't have a body, so you can just return `true`.
return true
})
note.With(notFound).Get("Get a note by its ID",
func(id string) (*huma.ErrorModel, *Note) {

40
examples/readme/main.go
View file

@ -33,22 +33,20 @@ func main() {
})
notes := r.Resource("/notes")
notes.List("Returns a list of all notes",
func() []*NoteSummary {
// Create a list of summaries from all the notes.
summaries := make([]*NoteSummary, 0)
notes.List("Returns a list of all notes", func() []*NoteSummary {
// Create a list of summaries from all the notes.
summaries := make([]*NoteSummary, 0)
memoryDB.Range(func(k, v interface{}) bool {
summaries = append(summaries, &NoteSummary{
ID: k.(string),
Created: v.(*Note).Created,
})
return true
memoryDB.Range(func(k, v interface{}) bool {
summaries = append(summaries, &NoteSummary{
ID: k.(string),
Created: v.(*Note).Created,
})
return true
})
return summaries
},
)
return summaries
})
// Add an `id` path parameter to create a note resource.
note := notes.With(huma.PathParam("id", "Note ID", &huma.Schema{
@ -57,16 +55,14 @@ func main() {
notFound := huma.ResponseError(http.StatusNotFound, "Note not found")
note.Put("Create or update a note",
func(id string, n *Note) bool {
// Set the created time to now and then save the note in the DB.
n.Created = time.Now()
memoryDB.Store(id, n)
note.Put("Create or update a note", func(id string, n *Note) bool {
// Set the created time to now and then save the note in the DB.
n.Created = time.Now()
memoryDB.Store(id, n)
// Empty responses don't have a body, so you can just return `true`.
return true
},
)
// Empty responses don't have a body, so you can just return `true`.
return true
})
note.With(notFound).Get("Get a note by its ID",
func(id string) (*huma.ErrorModel, *Note) {