面向AI的API设计，一键让你API智能化！在早先的一篇文章 RAFT & RAG & GraphRAG 探讨过 RAF

在早先的一篇文章 RAFT & RAG & GraphRAG 探讨过 RAFT 的方式让API 对 LLM 更友好，这期ApiHug 将这个内容，加入到API设计中，其实就是简简单单的一个 meta 标签：

  //  
  // Nature language questions act as few shots for LLMs context  
  // Same concept from Gorilla of Berkeley edu  
  // Make APIs friendly for LLMs  
  // 2024-08 added for AI trend by @Aaron  
  repeated string  questions = 800;

这样子在API 定义时候可以，给你API 加上额外几个 few shot：

  questions:[        
  "Charge Jenny Rosen $2000 in USD.",        
  "Can you check how much I charged Sam Rosen?",       
  "Undo my charge to Ronald Samuels"  ]

当然他们也被带入OAS 文档，供其他三方使用：

"x-hope-operation" : {         
    "deprecated" : false,         
    "priority" : "MIDDLE",          
    "group" : "CUSTOMER",          
    "security" : {            
        "roles" : [ "ADMIN" ],            
        "authorities" : [ "USER_DELETE" ],            
        "combinator" : "AND"          
        },          
    "questions" : [             
        "Charge Jenny Rosen $2000 in USD.",            
        "Can you check how much I charged Sam Rosen?",            
        "Undo my charge to Ronald Samuels"                      
        ]
}

当然标题有点夸张了，良好的API 只是为后面，任务规划，Agent设计提供不可多得的元材料，为必要非充分条件。

依托于工具和流程，可在设计,编译阶段加上更多的 rule check, 提前人肉对齐校验好，如API 缺 questions 设定，或者数量少于三个，为不合格，需退回重新设计！

玩转API

Quick start - ApiHug This page outlines how you can start using ApiHug to start a new API develop in 15 minutes. apihug.com/docs/start

📐设计先行

通过统一的API 设计元语(DSL, domain specific language), 让API 设计更语言化（Describe)；实现高度的一致化，和高复用。

📑协议驱动

OAS (OpenAPI specification), 是 ApiHug世界的 "金科玉律", 严格保证定义 ↔ 实现之间同构(isomorphism)态射。

🗺️单一信任源

实现 API 从：蓝图→施工→测试→落地，不走样，不变形，不改味。极致沟通效率和极低信任成本。

❤️ 开发同理心

置身于多种角色,感同身受，在快和慢，现在和将来,个体和团队上综合平衡，极具同理心是ApiHug 人文基础，她不仅仅是一段代码，一个工具，一种方式。

# Refer