[PR #5499] [MERGED] feat: API Documentation #5239

New issue

Closed

opened 2026-03-17 02:42:18 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 02:42:18 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/5499
Author: @nivedin
Created: 10/22/2025
Status: ✅ Merged
Merged: 11/25/2025
Merged by: @jamesgeorge007

Base: next ← Head: feat/hopp-doc

📝 Commits (10+)

2e11911 feat: add documentation schemas
1149af3 chore: add entry UI to doc
503a6d9 chore: add doc UI's
d50b563 chore: add doc in postman import
f44cb6d chore: add doc updates
19af366 chore: improve curl component and minor cleanup
9b5c3aa chore: cleanup
ce4d45e feat: add service worker and add loader
6d7f820 chore: improve curl view performance
c5e3fad chore: scroll to top

📊 Changes

85 files changed (+9889 additions, -128 deletions)

View changed files

➕ packages/hoppscotch-backend/prisma/migrations/20251110141554_api_doc/migration.sql (+17 -0)
📝 packages/hoppscotch-backend/prisma/schema.prisma (+15 -0)
📝 packages/hoppscotch-backend/src/app.module.ts (+2 -0)
📝 packages/hoppscotch-backend/src/errors.ts (+31 -0)
📝 packages/hoppscotch-backend/src/gql-schema.ts (+2 -0)
📝 packages/hoppscotch-backend/src/mock-server/mock-server.resolver.ts (+1 -5)
➕ packages/hoppscotch-backend/src/published-docs/input-type.args.ts (+81 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.controller.ts (+52 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.dto.ts (+19 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.model.ts (+118 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.module.ts (+14 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.resolver.ts (+205 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.service.spec.ts (+904 -0)
➕ packages/hoppscotch-backend/src/published-docs/published-docs.service.ts (+431 -0)
📝 packages/hoppscotch-backend/src/team-collection/team-collection.service.ts (+27 -15)
📝 packages/hoppscotch-backend/src/types/CollectionFolder.ts (+28 -2)
📝 packages/hoppscotch-backend/src/user-collection/user-collection.service.ts (+23 -19)
📝 packages/hoppscotch-cli/src/__tests__/unit/fixtures/workspace-access.mock.ts (+39 -15)
📝 packages/hoppscotch-cli/src/utils/workspace-access.ts (+3 -0)
📝 packages/hoppscotch-common/locales/en.json (+143 -1)

...and 65 more files

📄 Description

Closes FE-1031 BE-663.
Related to #4133.

What's changed

This PR introduces a comprehensive API Documentation feature to Hoppscotch, enabling users to create, edit, and view rich documentation for their API collections and requests. This enhancement transforms Hoppscotch from a pure testing tool into a complete API documentation platform.

This PR's add's the scope to publish a documentation to a public URL so it can be shared across.

Note: This is an initial MVP iteration of the documentation feature. We plan to continue iterating based on community feedback and real-world usage patterns.

https://github.com/user-attachments/assets/92c35626-65bd-4f4e-b157-e59bf347b63e

Backend Changes

(1) Descriptions for collection and requests will be handled by the frontend. Those information will be store as JSON string with other metadata (data/request column in database)

updateRESTUserRequest
updateGQLUserRequest

(2) Publishing a doc

(3) View a doc

Add BE support for SH and team workspaces
Add platform level additions
Polish UI
Test for migration issues
Fix tests
Update Documentation

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/5499 **Author:** [@nivedin](https://github.com/nivedin) **Created:** 10/22/2025 **Status:** ✅ Merged **Merged:** 11/25/2025 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `feat/hopp-doc` --- ### 📝 Commits (10+) - [`2e11911`](https://github.com/hoppscotch/hoppscotch/commit/2e11911d08ba3a946fa31b7a3a9bf669da244eaa) feat: add documentation schemas - [`1149af3`](https://github.com/hoppscotch/hoppscotch/commit/1149af31aba81cc22ede0f3497966d6e8cb67769) chore: add entry UI to doc - [`503a6d9`](https://github.com/hoppscotch/hoppscotch/commit/503a6d9f9e412ab5bb9c8bc03659e7e15c8aebe3) chore: add doc UI's - [`d50b563`](https://github.com/hoppscotch/hoppscotch/commit/d50b563b42ed9feccd076cd1c776d34094000139) chore: add doc in postman import - [`f44cb6d`](https://github.com/hoppscotch/hoppscotch/commit/f44cb6d7664f77e78682015638404bb8b4e03729) chore: add doc updates - [`19af366`](https://github.com/hoppscotch/hoppscotch/commit/19af3669d716ea527b90ca059b4678dc41315309) chore: improve curl component and minor cleanup - [`9b5c3aa`](https://github.com/hoppscotch/hoppscotch/commit/9b5c3aaebe6ca0a6312433d8f30e1e2f9f3bde55) chore: cleanup - [`ce4d45e`](https://github.com/hoppscotch/hoppscotch/commit/ce4d45ea20523eb5147de452ebacbd6c2cc765c7) feat: add service worker and add loader - [`6d7f820`](https://github.com/hoppscotch/hoppscotch/commit/6d7f820c228aa2cc44633e6a7fa9c303bc7ddf6e) chore: improve curl view performance - [`c5e3fad`](https://github.com/hoppscotch/hoppscotch/commit/c5e3fadb8e600158f1d7bf7730a08efe751f2e6d) chore: scroll to top ### 📊 Changes **85 files changed** (+9889 additions, -128 deletions) <details> <summary>View changed files</summary> ➕ `packages/hoppscotch-backend/prisma/migrations/20251110141554_api_doc/migration.sql` (+17 -0) 📝 `packages/hoppscotch-backend/prisma/schema.prisma` (+15 -0) 📝 `packages/hoppscotch-backend/src/app.module.ts` (+2 -0) 📝 `packages/hoppscotch-backend/src/errors.ts` (+31 -0) 📝 `packages/hoppscotch-backend/src/gql-schema.ts` (+2 -0) 📝 `packages/hoppscotch-backend/src/mock-server/mock-server.resolver.ts` (+1 -5) ➕ `packages/hoppscotch-backend/src/published-docs/input-type.args.ts` (+81 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.controller.ts` (+52 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.dto.ts` (+19 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.model.ts` (+118 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.module.ts` (+14 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.resolver.ts` (+205 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.service.spec.ts` (+904 -0) ➕ `packages/hoppscotch-backend/src/published-docs/published-docs.service.ts` (+431 -0) 📝 `packages/hoppscotch-backend/src/team-collection/team-collection.service.ts` (+27 -15) 📝 `packages/hoppscotch-backend/src/types/CollectionFolder.ts` (+28 -2) 📝 `packages/hoppscotch-backend/src/user-collection/user-collection.service.ts` (+23 -19) 📝 `packages/hoppscotch-cli/src/__tests__/unit/fixtures/workspace-access.mock.ts` (+39 -15) 📝 `packages/hoppscotch-cli/src/utils/workspace-access.ts` (+3 -0) 📝 `packages/hoppscotch-common/locales/en.json` (+143 -1) _...and 65 more files_ </details> ### 📄 Description Closes FE-1031 BE-663. Related to #4133. ### What's changed  This PR introduces a comprehensive API Documentation feature to Hoppscotch, enabling users to create, edit, and view rich documentation for their API collections and requests. This enhancement transforms Hoppscotch from a pure testing tool into a complete API documentation platform. This PR's add's the scope to publish a documentation to a public URL so it can be shared across. Note: This is an initial MVP iteration of the documentation feature. We plan to continue iterating based on community feedback and real-world usage patterns. https://github.com/user-attachments/assets/92c35626-65bd-4f4e-b157-e59bf347b63e #### Backend Changes (1) Descriptions for collection and requests will be handled by the frontend. Those information will be store as JSON string with other metadata (`data`/`request` column in database) ```GQL updateRESTUserRequest updateGQLUserRequest ``` (2) Publishing a doc (3) View a doc  - [x] Add BE support for SH and team workspaces - [x] Add platform level additions - [x] Polish UI - [x] Test for migration issues - [x] Fix tests - [ ] Update Documentation --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>