Skip to content

docs: update example #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 8, 2025
Merged

docs: update example #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ func main() {
o := okapi.Default()

o.Get("/", func(c okapi.Context) error {
return c.OK(okapi.M{"message": "Hello from Okapi Web Framework!","Licence":"MIT"})
return c.OK(okapi.M{"message": "Hello from Okapi Web Framework!","License":"MIT"})
})
// Start the server
if err := o.Start(); err != nil {
Expand Down Expand Up @@ -151,7 +151,7 @@ func main() {
return c.OK(response)
},
// OpenAPI Documentation
okapi.DocSummary("Create a new Book"),
okapi.DocSummary("Create a new Book"), // Route Summary
okapi.DocRequestBody(Book{}), // Request body
okapi.DocResponse(Response{}), // Success Response body
okapi.DocErrorResponse(http.StatusBadRequest, ErrorResponse{}), // Error response body
Expand All @@ -174,7 +174,7 @@ Visit [`http://localhost:8080`](http://localhost:8080) to see the response:

```json
{
"Licence": "MIT",
"License": "MIT",
"message": "Hello from Okapi Web Framework!"
}
```
Expand Down
2 changes: 1 addition & 1 deletion examples/sample/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func main() {
o := okapi.Default()

o.Get("/", func(c okapi.Context) error {
return c.OK(okapi.M{"message": "Hello from Okapi Web Framework!", "Licence": "MIT"})
return c.OK(okapi.M{"message": "Hello from Okapi Web Framework!", "License": "MIT"})
})
o.Post("/books", func(c okapi.Context) error {
book := Book{}
Expand Down