cnschema对接openapi数据接口设计

目标：基于cnSchema设计数据服务API的接口，由此形成符合openapi规范的接口定义YMAL文件。其中主要是利用基于cnSchema设计的schema和模拟数据，生成Schema和Example。

全流程

[ ] schema design - DONE，利用Excel模版可以人工构建，例如https://docs.google.com/spreadsheets/d/1iZYXZRQAuSAlUpdQdYRffrtJicurm6yUnsJDsEa2CAk/edit#gid=659512552
[ ] schema visualization - DONE，利用KGTOOL工具完成
[ ] schema validation - DONE，利用KGTOOL工具完成
[ ] data mockup (spreadsheet+neo4jstyle) - DONE，利用Excel模版可以人工构建，例如https://docs.google.com/spreadsheets/d/1VS2I1f8fb2CpDlbGhtBLJeYR1gAKX7BPmWTBvG-YKvg/edit#gid=191238384
[ ] data transformation (spreadsheet+neo4jstyle TO jsonld+flat) - TODO，利用KGTOOL研发
[ ] data visualization - TODO，利用KGTOOL研发
[ ] data validation - DONE，利用KGTOOL完成
[ ] interface design (openapi 3.0) - TODO 基于openapi3.0研发接口，使用POSTMAN或SWAGGER 定义API，主要针对数据接口（增删改查），而又以数据查询为主。返回格式采用与JSONLD标准一致的YAML。这里还需要设计一下，简单的逻辑就是复用Schema中的实体属性模版（Schema中来自Schema的类型直接使用从对应实体属性模版自动生成的YAML），其他要考虑的问题包括，实体分类的继承关系，多层级的查询结果的组织，二元关系以及上下文实体的处理（扁平化处理还是利用JSON多层次内嵌套）。另外，Schema与样例数据的自动生成应该又不少共通的处理逻辑。
[ ] interface schema composition (to yaml+openapi）- TODO
[ ] interface example data composition （jsonld+flat TO yaml+openapi) + TODO

reference

https://github.com/cnschema/kgtool
https://www.getpostman.com/
https://app.swaggerhub.com/home
cnSchema 2 documentation https://docs.google.com/document/d/19mi3rY1Haf2KY_0kehFAOejszHzyNG5uZTiyQiRclus/edit#

cnschema / cnSchema

cnschema对接openapi数据接口设计 #52