Cutelyst  2.5.0
Public Member Functions | Protected Member Functions | List of all members
Cutelyst::ActionREST Class Reference

Automated REST Method Dispatching. More...

#include <Cutelyst/Actions/REST/ActionREST>

Inheritance diagram for Cutelyst::ActionREST:
Inheritance graph

Public Member Functions

 ActionREST (QObject *parent=nullptr)
- Public Member Functions inherited from Cutelyst::Action
 Action (QObject *parent=nullptr)
QString attribute (const QString &name, const QString &defaultValue=QString()) const
QMap< QString, QString > attributes () const
QString className () const
Controllercontroller () const
bool dispatch (Context *c)
virtual bool match (int numberOfArgs) const
virtual bool matchCaptures (int numberOfCaptures) const
virtual Modifiers modifiers () const override
QString ns () const
virtual qint8 numberOfArgs () const
virtual qint8 numberOfCaptures () const
void setAttributes (const QMap< QString, QString > &attributes)
- Public Member Functions inherited from Cutelyst::Component
 Component (QObject *parent=nullptr)
bool execute (Context *c)
virtual bool init (Application *application, const QVariantHash &args)
QString name () const
QString reverse () const
void setName (const QString &name)
void setReverse (const QString &reverse)

Protected Member Functions

bool doExecute (Context *c) override
- Protected Member Functions inherited from Cutelyst::Action
void setController (Controller *controller)
void setMethod (const QMetaMethod &method)
void setupAction (const QVariantHash &args, Application *app)
- Protected Member Functions inherited from Cutelyst::Component
virtual bool afterExecute (Context *c)
void applyRoles (const QStack< Component *> &roles)
virtual bool aroundExecute (Context *c, QStack< Component *> stack)
virtual bool beforeExecute (Context *c)
virtual bool dispatcherReady (const Dispatcher *dispatch, Controller *controller)

Additional Inherited Members

- Public Types inherited from Cutelyst::Component
enum  Modifier {
  None, OnlyExecute, BeforeExecute, AroundExecute,

Detailed Description

C_ATTR(foo, :Local :ActionClass(REST))
void foo(Context *c); // do setup for HTTP method specific handlers
C_ATTR(foo_GET, :Private)
void foo_GET(Context *c); // do something for GET requests
C_ATTR(foo_PUT, :Private)
void foo_PUT(Context *c); // do something for PUT requests

This Action handles doing automatic method dispatching for REST requests. It takes a normal Cutelyst action, and changes the dispatch to append an underscore and method name. First it will try dispatching to an action with the generated name, and failing that it will try to dispatch to a regular method.

For example, in the synopsis above, calling GET on "/foo" would result in the foo_GET method being dispatched.

If a method is requested that is not implemented, this action will return a status 405 (Method Not Found). It will populate the "Allow" header with the list of implemented request methods. You can override this behavior by implementing a custom 405 handler like so:

C_ATTR(foo_not_implemented, :Private)
void foo_not_implemented(Context *c); // handle not implemented methods

If you do not provide an _OPTIONS method, we will automatically respond with a 200 OK. The "Allow" header will be populated with the list of implemented request methods. If you do not provide an _HEAD either, we will auto dispatch to the _GET one in case it exists.

Definition at line 28 of file actionrest.h.

Constructor & Destructor Documentation

◆ ActionREST()

ActionREST::ActionREST ( QObject *  parent = nullptr)

Constructs a new ActionREST object with the given parent.

Definition at line 62 of file actionrest.cpp.

Member Function Documentation

◆ doExecute()

bool ActionREST::doExecute ( Context c)