feat: 编写swagger注释并生成文档
This commit is contained in:
@@ -17,6 +17,15 @@ func NewNodeHandler(service services.GraphService) *NodeHandler {
|
||||
}
|
||||
}
|
||||
|
||||
// @Summary 获取节点详情
|
||||
// @Description 根据节点 ID 获取知识图谱中的节点详细信息
|
||||
// @Produce json
|
||||
// @Param id path string true "节点 ID"
|
||||
// @Success 200 {object} models.NodeResponse "成功"
|
||||
// @Failure 400 {object} models.ErrorResponse "请求错误"
|
||||
// @Failure 404 {object} models.ErrorResponse "节点未找到"
|
||||
// @Failure 500 {object} models.ErrorResponse "内部错误"
|
||||
// @Router /api/nodes/{id} [get]
|
||||
func (h *NodeHandler) GetNodeByID(c *gin.Context) {
|
||||
nodeID := c.Param("id")
|
||||
if nodeID == "" {
|
||||
@@ -39,6 +48,15 @@ func (h *NodeHandler) GetNodeByID(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, node)
|
||||
}
|
||||
|
||||
// @Summary 获取节点邻居
|
||||
// @Description 根据节点 ID 获取其所有邻居节点及关联边
|
||||
// @Produce json
|
||||
// @Param id path string true "节点 ID"
|
||||
// @Success 200 {object} models.NeighborResponse "成功"
|
||||
// @Failure 400 {object} models.ErrorResponse "请求错误"
|
||||
// @Failure 404 {object} models.ErrorResponse "节点未找到"
|
||||
// @Failure 500 {object} models.ErrorResponse "内部错误"
|
||||
// @Router /api/nodes/{id}/neighbors [get]
|
||||
func (h *NodeHandler) GetNeighbors(c *gin.Context) {
|
||||
nodeID := c.Param("id")
|
||||
if nodeID == "" {
|
||||
|
||||
Reference in New Issue
Block a user