improving-drf-endpoints

仓库创建 2020年1月24日最近提交 3 小时前SkillHot 收录 3 小时前

▸ 精选理由

确保字段文档与类型链路正确，减少前端猜测与接口错误

这个 Skill 做什么

审查与改进 Django REST Framework 视图集与序列化器的操作指南

能帮你把 Django REST Framework 的 viewset 和 serializer 写得干净、可用且对外接口描述准确。通常在改接口、做 code review 或审计时用，目的是保证字段类型、help_text 和 @extend_schema 注释都到位。特别之处是它关注每个 serializer 字段如何通过 drf-spectacular、OpenAPI 等一路影响到生成的 TypeScript 类型和下游工具。

▸ 展开 SKILL.md 英文原文

Use when editing, reviewing, or auditing DRF viewsets and serializers in PostHog. Triggers on files in posthog/api/, products/*/backend/api/, products/*/backend/presentation/, or any file importing rest_framework. Covers field typing, schema annotations, enum collision fixes, and OpenAPI spec quality — everything that flows downstream into generated TypeScript types and MCP tools.

开发编程DRF序列化器OpenAPI通用

3.7w

Stars

3.1k

Forks

仓库内 Skill

积累中

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/PostHog/posthog/master/.agents/skills/improving-drf-endpoints/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/PostHog/posthog/master/.agents/skills/improving-drf-endpoints/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Improving DRF Endpoints

## Overview

Serializer fields are the source of truth for PostHog's entire type pipeline:

```text
Django serializer → drf-spectacular → OpenAPI JSON → Orval → Zod schemas → MCP tools
```

Every `help_text`, every field type, every `@extend_schema` annotation flows downstream.
A missing `help_text` means an agent guessing at parameters.
A bare `ListField()` means `z.unknown()` in the generated Zod schema.
Getting the serializer right means every consumer — frontend types, MCP tools, API docs — gets correct types and descriptions automatically.

## When to use

- Editing or reviewing any file that defines a `Serializer` or `ViewSet`
- Fixing OpenAPI spec warnings o

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有