Document the shutdown contract for `POST /proxy/stopProxy`

未关闭
#2,081 0 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@waldekmastykarz 已经在做这个了。

开始于 2026年11月5日。

评估

这个 Issue 还没有评估数据。

描述

documentation work in progress

Problem

The Proxy API page says only "Gracefully shuts down Dev Proxy" and returns 202 Accepted. It doesn't say:

  • whether recording is stopped and reports are written before exit,
  • that system proxy and certificate changes are reverted,
  • how long shutdown typically takes and what exit code to expect,
  • how a script knows Dev Proxy has exited. The CI/CD overview suggests grepping the log for DONE, but that's not linked from here.

Without this, every agent-written script added a 15–30 s wait and a kill fallback. Killing the process skips cleanup.

Proposal

Under POST /proxy/stopproxy, document what happens on shutdown and in what order, plus the recommended way to wait for exit. Examples: wait on the PID returned by --detach, poll devproxy status --pid <pid>, or check the log for DONE. Note that the API is no longer reachable once shutdown starts.

Found while evaluating how coding agents use Dev Proxy: VS Code + GitHub Copilot Chat with Claude Sonnet 5.5, Dev Proxy 4.0.0 on Windows, 5 runs of the task "add a CI script that starts Dev Proxy in the background, starts and stops recording through the API around npm start, and shuts Dev Proxy down through the API".

主要语言
C#
星标
841
派生
90
平均合并
2 天 10 小时
30 天内合并 PR
63

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

dotnet/dev-proxy 的其他 Issue

查看 dotnet/dev-proxy 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。