050_knowledge.md

title	description
IDE 知识库	知识库管理

0.5.4 upgrade

014 Knowledge Settings new web site;

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

1. need to keep it in project source code to leverage the version control;
2. each module(domain) will has 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!

---

⚠️⚠️ After IDEA Plugin 0.2.6+

⚠️Decoded after 0.5.4⚠️

SDK:

Plugin: ApiHug - API design Copilot

if your plugin still 0.1* please follow this: 0.1->0.2* plugin migration to upgrade firstly!

什么是知识库

🎁 团队共享设计标准共识, Team-shared design standards consensus

1. 设计标准
2. 领域知识
3. 团队共识

配置

1. Topbar>ApiHug>Knowledge
2. Actions
   1. Add: Add new knowledge
   2. Delete: Remove a knowledge
   3. Download Template: download Excel template for edit by batch 中文模板， English template
   4. Import from template: import a modified excel/json file
   5. Export for share: export current knowledge for share with other members
3. Double click table row for modify!

1. type for auto-complete

模板

1. 快速构建
2. 有限支持
3. json vs excel

共享

1. 导入
2. 导出

Merger 规则。

使用

1. Add Field
2. Auto complete (TBD)

Reference

1. ApiHug101-Bilibili
2. ApiHug101-Youtube