openapi
Build OpenAPI Documentation for .NET 10 APIs
API documentation can miss response schemas, endpoint descriptions, and authentication metadata. This skill guides built-in .NET 10 OpenAPI setup with typed responses and transformers.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "openapi" from https://skillstore.io/skills/codewithmukesh-openapi.md and its manifest at https://skillstore.io/api/skills/codewithmukesh-openapi/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Ресурсы для AI-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «openapi». My order lookup returns either an order or a missing result. How can I improve its OpenAPI response documentation?
Ожидаемый результат:
- Use a typed union covering successful order responses and missing resources.
- Return typed results so response schemas can be inferred.
- Assign a stable operation name and a short endpoint summary.
Использование «openapi». We need separate public and internal API specifications.
Ожидаемый результат:
- Register separate named OpenAPI documents.
- Assign endpoint group names to select their documents.
- Review ungrouped endpoints because they appear in all documents.
- Enforce authorization separately; document grouping does not restrict endpoint access.
Использование «openapi». How should I customize an endpoint that is being retired?
Ожидаемый результат:
- Use a per-endpoint operation transformer to mark the operation as deprecated.
- Avoid the deprecated WithOpenApi customization method in .NET 10.
- Check the resulting specification with your documentation UI and client consumers.
Аудит безопасности
БезопасноAll 49 static findings are false positives: 47 match Markdown backticks, and two match C# identifier parameters rather than reconnaissance commands. No evidence found of prompt injection, credential theft, malicious command execution, or data exfiltration in the reviewed skill.
Факторы риска
⚙️ Внешние команды (47)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/codewithmukesh-openapi/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](https://skillstore.io/skills/codewithmukesh-openapi?utm_source=security_passport_badge)Значок HTML
<a href="https://skillstore.io/skills/codewithmukesh-openapi?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/codewithmukesh-openapi/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Встраиваемая карточка
<iframe src="https://skillstore.io/embed/skills/codewithmukesh-openapi.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Академические ссылки (APA · BibTeX · CFF)
Цитата APA
codewithmukesh. (2026). openapi security audit report (audit version 1) [Author version unspecified]. Skillstore. https://skillstore.io/skills/codewithmukesh-openapi/audits/1Цитата BibTeX
@techreport{codewithmukesh-codewithmukesh-openapi-2026,
author = {codewithmukesh},
title = {openapi security audit report (audit version 1)},
institution = {Skillstore},
year = {2026},
number = {1},
url = {https://skillstore.io/skills/codewithmukesh-openapi/audits/1},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "openapi security audit report (audit version 1)"
version: "unspecified"
type: report
authors:
- name: "codewithmukesh"
date-released: "2026-10-31"
url: "https://skillstore.io/skills/codewithmukesh-openapi/audits/1"
identifiers:
- type: other
value: "skillstore:codewithmukesh-openapi:audit:1"
description: "Skillstore immutable audit report identifier"
Оценка Skillstore
Почему такая оценка Достоверность доказательств: СреднийЧто вы можете построить
Document a new API
Set up built-in OpenAPI generation with named endpoints and typed success and error responses.
Improve API reference quality
Combine XML comments, endpoint summaries, response metadata, and document descriptions for clearer API references.
Standardize API contracts
Plan named documents, shared transformers, and build-time specification generation across services.
Попробуйте эти промпты
Show basic OpenAPI setup for my .NET 10 minimal API. Expose the document only in development.
Review this endpoint: [paste endpoint]. Suggest named operations, summaries, tags, and typed success and error responses.
Use a document transformer to describe bearer authentication for my .NET 10 API. Explain which runtime authorization settings remain separate.
For these endpoints [paste endpoints], propose public and internal OpenAPI documents, XML comment integration, schema customization, and build-time generation. Identify required package checks.
Лучшие практики
- Use stable operation names, concise summaries, and typed response unions for each documented endpoint.
- Keep runtime authorization separate from documentation metadata, and restrict specification exposure according to your deployment policy.
- Validate generated specifications against your installed package versions and downstream documentation or client tools.
Избегать
- Assuming a bearer security scheme in the specification protects application endpoints.
- Leaving internal endpoints ungrouped when generating public and internal documents.
- Copying examples without checking framework compatibility, package versions, and generated response schemas.
Часто задаваемые вопросы
Which framework version does this skill target?
Does it require Swashbuckle?
Does adding a bearer scheme secure my API?
Can it separate public and internal documentation?
Does it provide an interactive documentation UI?
Does the skill execute builds or generate clients itself?
Сведения для разработчиков
Автор
codewithmukeshЛицензия
MIT
Ревизия Skillstore
r1
Примечание о версии
Автор не указал версию.
Ссылка
50cc168fac873d463b39e9ea9e5326565a7f37a6
Актуальность поддержки
31.10.2026
Использование
0 загрузок · 0 просмотров
Структура файлов
📄 SKILL.md