Swagger: Implement responses object for endpoints

src/action.cpp

@@ -139,6 +139,11 @@ std::vector<Input> Action::getInputs() const
   return EMPTY_INPUTS;
 }
 
+std::map<qttp::HttpStatus, QString> Action::getResponses() const
+{
+  return {};
+}
+
 std::vector<QStringPair> Action::getHeaders() const
 {
   return Global::getDefaultHeaders();
@@ -251,6 +256,16 @@ std::vector<Input> SimpleAction::getInputs() const
   return m_Inputs;
 }
 
+void SimpleAction::setResponses(const std::map<qttp::HttpStatus, QString>& responses)
+{
+  m_Responses.insert(responses.begin(), responses.end());
+}
+
+std::map<qttp::HttpStatus, QString> SimpleAction::getResponses() const
+{
+  return m_Responses;
+}
+
 std::vector<QStringPair> SimpleAction::getHeaders() const
 {
   return m_Headers;

src/action.h

@@ -1,6 +1,8 @@
 #ifndef QTTPACTION_H
 #define QTTPACTION_H
 
+#include <map>
+
 #include "qttp_global.h"
 #include "httproute.h"
 #include "httpdata.h"
@@ -60,6 +62,9 @@ class QTTPSHARED_EXPORT Action
     //! The inputs help SwaggerUI include parameters.
     virtual std::vector<Input> getInputs() const;
 
+    //! The possible responses of this action - used for SwaggerUI.
+    virtual std::map<qttp::HttpStatus, QString> getResponses() const;
+
     bool registerRoute(HttpMethod method, const QString& path, Visibility visibility = Visibility::Show);
     bool registerRoute(const qttp::HttpPath& path, Visibility visibility = Visibility::Show);
     void registerRoute(const std::vector<qttp::HttpPath>& routes, Visibility visibility = Visibility::Show);
@@ -118,6 +123,9 @@ class QTTPSHARED_EXPORT SimpleAction : public Action
     void setInputs(const std::vector<Input>& inputs);
     std::vector<Input> getInputs() const;
 
+    void setResponses(const std::map<qttp::HttpStatus, QString>& responses);
+    std::map<qttp::HttpStatus, QString> getResponses() const;
+
 QTTP_PROTECTED:
 
     std::vector<QStringPair> getHeaders() const;
@@ -131,6 +139,7 @@ class QTTPSHARED_EXPORT SimpleAction : public Action
     QByteArray m_Description;
     QStringList m_Tags;
     std::vector<Input> m_Inputs;
+    std::map<qttp::HttpStatus, QString> m_Responses;
     std::vector<QStringPair> m_Headers;
 };
 

src/swagger.cpp

@@ -84,6 +84,14 @@ void Swagger::initialize()
     QJsonArray required;
     QJsonArray tags = QJsonArray::fromStringList(action->getTags());
 
+    QJsonObject responses;
+    for(auto response : action->getResponses())
+    {
+      responses.insert(QString::number(static_cast<int>(response.first)), QJsonObject {
+        { "description", response.second }
+      });
+    }
+
     QString actionName = action->getName();
     const vector<Input> & inputs = action->getInputs();
 
@@ -216,7 +224,8 @@ void Swagger::initialize()
           { "description", action->getDescription() },
           { "operationId", routePath },
           { "parameters", routeParameters },
-          { "tags", tags }
+          { "tags", tags },
+          { "responses", responses }
         });
         paths[routePath] = pathRoute;
       }