014 Knowledge Settings

How to configure team-shared knowledge for domain with ApiHug Api design Copilot.

​What is Team knowledge base

🎁 Team-Shared Design Standards Consensus

1. Design Standards
2. Domain Knowledge
3. Team Consensus

​0.5.4 upgrade

Since IDEA Plugin 0.5.4+ we move maintain of the knowledge as Project framework metadata, so you:

1. need to keep it in project source code to leverage the version control;
2. each module(domain) will have its own domain knowledge base;

The knowledge base configuration will host {WIRE_MODULE}/src/main/resources/hope-knowledge.json, please refer to this sample.

{
  "knowledge" : [ {
    "name" : "user_name",
    "description" : "name of user",
    "attributeType" : "STRING",
    "notNull" : false,
    "notEmpty" : false,
    "notBlank" : true,
    "pattern" : "",
    "minLength" : 1,
    "maxLength" : 64,
    "sample" : "jake",
    "trackId" : "04b01f17-dc5b-44ce-b7ad-da7744dae723",
    "usage" : "BOTH"
  } ],
  "name" : "apihug-demo-proto",
  "application" : "apihug-demo",
  "packageName" : "com.apihug.sample",
  "domain" : "sample",
  "identifier" : "apihug-demo-proto",
  "module" : "apihug-demo-proto"
}

All other behavior keep same(except you don’t need go to the IDEA settings to set the knowledge, in each project module instead)!

​Old Way

⚠️This menu removed after 0.5.4⚠️ just open the hope-knowledge.json to edit;

1. open ApiHug > Settings
2. choice Knowledge tab
3. Set up your domain knowledge base

​Reference

1. ApiHug101-Bilibili
2. ApiHug101-Youtube