examples

package module

v0.32.1 Latest Latest Go to latest Published: May 25, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/go-openapi/runtime

Links

Open Source Insights

Documentation ¶

Overview ¶

Package examples contains many code examples.

They illustrate how to use github.com/go-openapi/runtime.

Code snippets are injected in the documentation site.

Source Files ¶

View all Source files

doc.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
auth
apikey command Command apikey backs the snippets on the doc-site "API key (single scheme)" example page.	Command apikey backs the snippets on the doc-site "API key (single scheme)" example page.
basic command Command basic backs the snippets on the doc-site "HTTP Basic" auth recipe page.	Command basic backs the snippets on the doc-site "HTTP Basic" auth recipe page.
bearerjwt command Command bearerjwt backs the snippets on the doc-site "Bearer + JWT" recipe page (usage/examples/auth/bearer-jwt.md).	Command bearerjwt backs the snippets on the doc-site "Bearer + JWT" recipe page (usage/examples/auth/bearer-jwt.md).
clientside command Command clientside backs the snippets on the doc-site "Client-side credentials" recipe page.	Command clientside backs the snippets on the doc-site "Client-side credentials" recipe page.
composed command Command composed backs the snippets on the doc-site "Composed schemes (AND / OR)" recipe page (usage/examples/auth/composed.md).	Command composed backs the snippets on the doc-site "Composed schemes (AND / OR)" recipe page (usage/examples/auth/composed.md).
customauthorizer command Command customauthorizer backs the snippets on the doc-site "Custom Authorizer (RBAC)" recipe page.	Command customauthorizer backs the snippets on the doc-site "Custom Authorizer (RBAC)" recipe page.
oauth2 command Command oauth2 backs the snippets on the doc-site "OAuth2 access-code (Google)" recipe page (usage/examples/auth/oauth2-access-code.md).	Command oauth2 backs the snippets on the doc-site "OAuth2 access-code (Google)" recipe page (usage/examples/auth/oauth2-access-code.md).
client
auth command Command auth backs the snippets on the doc-site "Client / Authentication" page.	Command auth backs the snippets on the doc-site "Client / Authentication" page.
intro command Command intro backs the snippet on the doc-site "Client" landing page.	Command intro backs the snippet on the doc-site "Client" landing page.
requests command Command requests backs the snippets on the doc-site "Building & submitting requests" page.	Command requests backs the snippets on the doc-site "Building & submitting requests" page.
tracing command Command tracing backs the snippets on the doc-site "Client / Tracing" page.	Command tracing backs the snippets on the doc-site "Client / Tracing" page.
transport command Command transport backs the snippets on the doc-site "Transport" page.	Command transport backs the snippets on the doc-site "Transport" page.
contenttypes
contenttyper command Command contenttyper backs the snippets on the doc-site "Per-payload Content-Type override" page.	Command contenttyper backs the snippets on the doc-site "Per-payload Content-Type override" page.
customcodec command Command customcodec backs the snippets on the doc-site "Custom codec (MessagePack)" recipe page.	Command customcodec backs the snippets on the doc-site "Custom codec (MessagePack)" recipe page.
negotiatestandalone command Command negotiatestandalone backs the snippets on the doc-site "Negotiation in plain net/http" page.	Command negotiatestandalone backs the snippets on the doc-site "Negotiation in plain net/http" page.
streamingbodies command Command streamingbodies backs the snippets on the doc-site "Streaming bodies" example page.	Command streamingbodies backs the snippets on the doc-site "Streaming bodies" example page.
vendortypes command Command vendortypes backs the snippets on the doc-site "Vendor MIME types" page.	Command vendortypes backs the snippets on the doc-site "Vendor MIME types" page.
core
contenttypes command Command contenttypes backs the snippets on the doc-site "Content types" page.	Command contenttypes backs the snippets on the doc-site "Content types" page.
validation command Command validation backs the snippets on the doc-site "Validation hooks" page.	Command validation backs the snippets on the doc-site "Validation hooks" page.
customcodec Package customcodec illustrates how to implement a runtime.Consumer for a custom wire format.	Package customcodec illustrates how to implement a runtime.Consumer for a custom wire format.
middleware
compression command Package main shows how to add transparent response compression (gzip, brotli, etc.) to a go-openapi server by wrapping the http.Handler returned by middleware.Serve with the CAFxX httpcompression adapter.	Package main shows how to add transparent response compression (gzip, brotli, etc.) to a go-openapi server by wrapping the http.Handler returned by middleware.Serve with the CAFxX httpcompression adapter.
server
binding command Command binding backs the snippets on the doc-site "Parameter binding & validation" page.	Command binding backs the snippets on the doc-site "Parameter binding & validation" page.
deprecatedshims command Command deprecatedshims backs the snippets on the doc-site "Deprecated shims" page.	Command deprecatedshims backs the snippets on the doc-site "Deprecated shims" page.
pipeline command Command pipeline backs the snippets on the doc-site "Request pipeline" page.	Command pipeline backs the snippets on the doc-site "Request pipeline" page.
security command Command security backs the snippets on the doc-site "Security schemes" page.	Command security backs the snippets on the doc-site "Security schemes" page.
standalone
contentnegotiation command Command contentnegotiation backs the snippets on the doc-site "Content negotiation" page (usage/standalone/content-negotiation.md).	Command contentnegotiation backs the snippets on the doc-site "Content negotiation" page (usage/standalone/content-negotiation.md).
docui command Command docui backs the snippets on the doc-site "Doc UIs & spec serving" page.	Command docui backs the snippets on the doc-site "Doc UIs & spec serving" page.
mediatypes command Command mediatypes backs the snippets on the doc-site "Media types" page.	Command mediatypes backs the snippets on the doc-site "Media types" page.