moonbitstack/moonapi/openapi

README
U
ApiHandler
U
ApiInfo
U
ApiKey
U
ApiKeyIn
U
AuthenticatedUser
U
BackgroundHandler
U
BackgroundTasks
U
BasicAuth
U
Constraint
U
Contact
U
Container
U
Context
U
CorsConfig
U
Deps
U
DigestAuth
U
Endpoint
U
ExceptionHandler
U
Field
U
HttpBasicCredentials
U
HttpException
U
License
U
Method
U
OAuth2CodeBearer
U
OAuth2PasswordBearer
U
OAuth2PasswordRequestForm
U
ObjectSchema
U
OpenApiVersion
U
Param
U
ParamLoc
U
Provider
U
ResponseSpec
U
Router
U
Schema
U
Scope
U
SecurityRequirement
U
SecurityScheme
U
SecurityScopes
U
Server
U
StreamHandler
U
ToSchema
U
Unresolved
U
ValidationError
U
WebSocket
U
WsHandler
U
WsMessage
- ::add_security_schemeApp::add_security_scheme
- ::add_status_handlerApp::add_status_handler
- ::deleteApp::delete
- ::dependsApp::depends
- ::describeApp::describe
- ::enable_docsApp::enable_docs
- ::exception_handlerApp::exception_handler
- ::getApp::get
- ::handleApp::handle
- ::handle_with_backgroundApp::handle_with_background
- ::handle_with_streamApp::handle_with_stream
- ::include_routerApp::include_router
- ::lifespan_handlerApp::lifespan_handler
- ::middlewareApp::middleware
- ::mountApp::mount
- ::mount_handlerApp::mount_handler
- ::newApp::new
- ::on_shutdownApp::on_shutdown
- ::on_startupApp::on_startup
- ::openapiApp::openapi
- ::openapi_jsonApp::openapi_json
- ::patchApp::patch
- ::postApp::post
- ::putApp::put
- ::routeApp::route
- ::route_bgApp::route_bg
- ::route_streamApp::route_stream
- ::secure_api_keyApp::secure_api_key
- ::secure_basicApp::secure_basic
- ::secure_bearerApp::secure_bearer
- ::secure_digestApp::secure_digest
- ::secure_oauth2App::secure_oauth2
- ::secure_oauth2_codeApp::secure_oauth2_code
- ::secure_openidApp::secure_openid
- ::set_clockApp::set_clock
- ::streamApp::stream
- ::to_asgiApp::to_asgi
- ::url_forApp::url_for
- ::websocketApp::websocket
T
Mount
V
HTTP_100_CONTINUE
V
HTTP_101_SWITCHING_PROTOCOLS
V
HTTP_102_PROCESSING
V
HTTP_103_EARLY_HINTS
V
HTTP_200_OK
V
HTTP_201_CREATED
V
HTTP_202_ACCEPTED
V
HTTP_203_NON_AUTHORITATIVE_INFORMATION
V
HTTP_204_NO_CONTENT
V
HTTP_205_RESET_CONTENT
V
HTTP_206_PARTIAL_CONTENT
V
HTTP_207_MULTI_STATUS
V
HTTP_208_ALREADY_REPORTED
V
HTTP_226_IM_USED
V
HTTP_300_MULTIPLE_CHOICES
V
HTTP_301_MOVED_PERMANENTLY
V
HTTP_302_FOUND
V
HTTP_303_SEE_OTHER
V
HTTP_304_NOT_MODIFIED
V
HTTP_305_USE_PROXY
V
HTTP_306_RESERVED
V
HTTP_307_TEMPORARY_REDIRECT
V
HTTP_308_PERMANENT_REDIRECT
V
HTTP_400_BAD_REQUEST
V
HTTP_401_UNAUTHORIZED
V
HTTP_402_PAYMENT_REQUIRED
V
HTTP_403_FORBIDDEN
V
HTTP_404_NOT_FOUND
V
HTTP_405_METHOD_NOT_ALLOWED
V
HTTP_406_NOT_ACCEPTABLE
V
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
V
HTTP_408_REQUEST_TIMEOUT
V
HTTP_409_CONFLICT
V
HTTP_410_GONE
V
HTTP_411_LENGTH_REQUIRED
V
HTTP_412_PRECONDITION_FAILED
V
HTTP_413_REQUEST_ENTITY_TOO_LARGE
V
HTTP_414_REQUEST_URI_TOO_LONG
V
HTTP_415_UNSUPPORTED_MEDIA_TYPE
V
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
V
HTTP_417_EXPECTATION_FAILED
V
HTTP_418_IM_A_TEAPOT
V
HTTP_421_MISDIRECTED_REQUEST
V
HTTP_422_UNPROCESSABLE_ENTITY
V
HTTP_423_LOCKED
V
HTTP_424_FAILED_DEPENDENCY
V
HTTP_425_TOO_EARLY
V
HTTP_426_UPGRADE_REQUIRED
V
HTTP_428_PRECONDITION_REQUIRED
V
HTTP_429_TOO_MANY_REQUESTS
V
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
V
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
V
HTTP_500_INTERNAL_SERVER_ERROR
V
HTTP_501_NOT_IMPLEMENTED
V
HTTP_502_BAD_GATEWAY
V
HTTP_503_SERVICE_UNAVAILABLE
V
HTTP_504_GATEWAY_TIMEOUT
V
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
V
HTTP_506_VARIANT_ALSO_NEGOTIATES
V
HTTP_507_INSUFFICIENT_STORAGE
V
HTTP_508_LOOP_DETECTED
V
HTTP_510_NOT_EXTENDED
V
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
V
WS_1000_NORMAL_CLOSURE
V
WS_1001_GOING_AWAY
V
WS_1002_PROTOCOL_ERROR
V
WS_1003_UNSUPPORTED_DATA
V
WS_1005_NO_STATUS_RCVD
V
WS_1006_ABNORMAL_CLOSURE
V
WS_1007_INVALID_FRAME_PAYLOAD_DATA
V
WS_1008_POLICY_VIOLATION
V
WS_1009_MESSAGE_TOO_BIG
V
WS_1010_MANDATORY_EXT
V
WS_1011_INTERNAL_ERROR
V
WS_1012_SERVICE_RESTART
V
WS_1013_TRY_AGAIN_LATER
V
WS_1014_BAD_GATEWAY
V
WS_1015_TLS_HANDSHAKE
V
check_constraints
V
cors
V
create_access_token
V
data_response
V
data_url
V
delete_cookie
V
drive_websocket
V
file_response
V
filter_response
V
gzip
V
html
V
http_error
V
json
V
json_model
V
parse_basic_auth
V
query_limits
V
redirect
V
redoc_ui
V
schema_of
V
set_cookie
V
sse_response
V
swagger_ui
V
text
V
token_response
V
unprocessable
V
validate_schema
V
validation_error_body
V
with_constraints

moonbitstack/moonapi/openapi does not have a README file

ApiInfo

pub(all) struct ApiInfo {
  title : String
  api_version : String
  description : String
  terms_of_service : String
  contact : Contact?
  license : License?
  servers : Array[Server]
}

What the document says about the API itself — FastAPI's info block plus servers. An app carries one (App::describe sets it) so that every emission of the document, including the route enable_docs registers, agrees.

ApiInfo::new

source

fn ApiInfo::new() -> ApiInfo

The defaults an app starts with.

Contact

source

pub(all) struct Contact {
  name : String
  url : String
  email : String
}

Build the OpenAPI / Swagger document for the app as a Json value, walking the registered routes once into paths → methods → operations. OpenAPI contact info (← FastAPI's contact): every field optional, emitted only when non-empty.

License

source

pub(all) struct License {
  name : String
  url : String
}

OpenAPI license info (← FastAPI's license_info): name required, url optional.

Server

source

pub(all) struct Server {
  url : String
  description : String
}

A servers entry (← FastAPI's servers): a base URL and an optional description.

redoc_ui

source

fn redoc_ui(spec_url? : String, title? : String) -> String

A self-contained ReDoc page rendering the document served at spec_url — the second reading of the same spec FastAPI serves at /redoc, three-panel and built for reading rather than for trying calls out.

swagger_ui

source

fn swagger_ui(spec_url? : String, title? : String) -> String

A self-contained Swagger UI page rendering the document served at spec_url.

Source Files

openapi.mbt

Install

Download zip

moonapi — a typed web framework for MoonBit (\u2190 FastAPI): routing, typed extractors, descriptor-driven validation, multi-version OpenAPI/Swagger (2.0 / 3.0 / 3.1) with security schemes, dependency injection, OAuth2 password-bearer with scopes, per-operation security enforcement, multipart and urlencoded form extractors, response_model filtering, background tasks, sub-application mounting, a CORS/gzip/exception-handler middleware stack with per-status handlers, Server-Sent Events, and WebSocket routes, on the moonasgi SEAM.

fastapiwebframeworkopenapiswaggerasgimoonbit