Crate paperclip_macros

source ·
Expand description

Convenience macros for paperclip.

You shouldn’t need to depend on this, because the stuff here is already exposed by the corresponding crates.

Attribute Macros

  • Marker attribute for indicating that the marked object can represent non-2xx (error) status codes with optional descriptions.
  • Marker attribute for indicating that the marked object can filter error responses from the the #[api_v2_errors] macro.
  • Marker attribute for indicating that a function is an OpenAPI v2 compatible operation.
  • Converts your struct to support deserializing from an OpenAPI v2 Schema object (example). This adds the necessary fields (in addition to your own fields) and implements the Schema trait for parsing and codegen.
  • Creates route handler with paperclip::actix::web::Resource. In order to control the output type and status codes the return value/response must implement the trait actix_web::Responder.
  • Creates route handler with paperclip::actix::web::Resource. In order to control the output type and status codes the return value/response must implement the trait actix_web::Responder.
  • Creates route handler with paperclip::actix::web::Resource. In order to control the output type and status codes the return value/response must implement the trait actix_web::Responder.
  • Creates route handler with paperclip::actix::web::Resource. In order to control the output type and status codes the return value/response must implement the trait actix_web::Responder.
  • Creates route handler with paperclip::actix::web::Resource. In order to control the output type and status codes the return value/response must implement the trait actix_web::Responder.
  • Creates route handler with paperclip::actix::web::Resource. In order to control the output type and status codes the return value/response must implement the trait actix_web::Responder.

Derive Macros

  • Derive attribute for indicating that a type is an OpenAPI v2 compatible header parameter.
  • Derive attribute for indicating that a type is an OpenAPI v2 compatible definition.
  • Marker attribute for indicating that an object forbids public access to operation (for example AccessToken).