json_schema.h

Go to the documentation of this file.

// Copyright (C) 2013-2020 iFunFactory Inc. All Rights Reserved.
//
// This work is confidential and proprietary to iFunFactory Inc. and
// must not be used, disclosed, copied, or distributed without the prior
// consent of iFunFactory Inc.

#ifndef INCLUDE_FUNAPI_COMMON_JSON_SCHEMA_H_
#define INCLUDE_FUNAPI_COMMON_JSON_SCHEMA_H_

#include <funapi/common/json.h>
#include <funapi/types.h>

#include <vector>


namespace fun {

class FUNAPI_DLL_VISIBILITY JsonSchema {
 public:
  enum Type {
    kInvalid = 0,
    kBoolean,
    kInteger,
    kDouble,
    kString,
    kObject,
    kArray
  };

  static const JsonSchema kNull;

  // for object attribute for all types
  JsonSchema(const string &name, const Type &type, const bool &required);
  // for object attribute for object or array
  JsonSchema(const string &name, const Type &type, const bool &required,
             const JsonSchema &e1, const JsonSchema &e2 = kNull,
             const JsonSchema &e3 = kNull, const JsonSchema &e4 = kNull,
             const JsonSchema &e5 = kNull, const JsonSchema &e6 = kNull,
             const JsonSchema &e7 = kNull, const JsonSchema &e8 = kNull,
             const JsonSchema &e9 = kNull, const JsonSchema &e10 = kNull,
             const JsonSchema &e11 = kNull, const JsonSchema &e12 = kNull);
  // for array element for all types
  explicit JsonSchema(const Type &type);
  // for root object or array element for object or array
  JsonSchema(const Type &type, const JsonSchema &e1,
             const JsonSchema &e2 = kNull, const JsonSchema &e3 = kNull,
             const JsonSchema &e4 = kNull, const JsonSchema &e5 = kNull,
             const JsonSchema &e6 = kNull, const JsonSchema &e7 = kNull,
             const JsonSchema &e8 = kNull, const JsonSchema &e9 = kNull,
             const JsonSchema &e10 = kNull, const JsonSchema &e11 = kNull,
             const JsonSchema &e12 = kNull);

  bool ValidateJsonMessage(const Json &json_object) const;

  bool HasName() const;
  const string &name() const;
  Type type() const;
  bool required() const;
  const std::vector<JsonSchema> &items() const;
  void insert(const JsonSchema &item);
  void insert(const std::vector<JsonSchema> &items);

 private:
  static bool ValidateJsonMessage(const Json &json,
                                  const JsonSchema &json_schema);

  string name_;
  Type type_;
  bool required_;
  std::vector<JsonSchema> items_;
};


FUNAPI_DLL_VISIBILITY bool operator !=(const JsonSchema &lhs, const JsonSchema &rhs);
FUNAPI_DLL_VISIBILITY bool operator ==(const JsonSchema &lhs, const JsonSchema &rhs);

}  // namespace fun

#endif  // INCLUDE_FUNAPI_COMMON_JSON_SCHEMA_H_