mirror of
https://github.com/supabase/supabase.git
synced 2026-10-11 04:15:04 +03:00
Feature / Refactor ## What is the current behavior? Data API docs live at the `/api` route as a standalone page. Old links point to the previous location. ## What is the new behavior? Data API docs are moved to the integrations section with a dedicated docs tab and settings tab. Old links are cleaned up, a mobile menu is added for data API docs navigation, and minor code review fixes are applied. ## Additional context Resolves FE-2517 ## Summary by CodeRabbit * **New Features** * Revamped API docs UI with reusable section layout, language toggle (JS/Bash), API key selection, and improved code snippets * Added Data API docs tab, mobile navigation, and dedicated loading/error/disabled states * **Navigation Updates** * Moved API docs and related links into the Integrations/Data API area and added redirects to new routes * Updated various internal links to the new Data API settings and overview locations * **Tests** * Added comprehensive unit tests for Data API utilities
92 lines
3.5 KiB
TypeScript
92 lines
3.5 KiB
TypeScript
import { useParams } from 'common'
|
|
import { useMemo, useState } from 'react'
|
|
import { ShimmeringLoader } from 'ui-patterns'
|
|
|
|
import type { ShowApiKey } from '../../Docs/Docs.types'
|
|
import { LangSelector } from '../../Docs/LangSelector'
|
|
import { DataApiDisabledState } from '@/components/interfaces/Integrations/DataApi/DataApiDisabledState'
|
|
import { DocsMenu } from '@/components/interfaces/Integrations/DataApi/DocsMenu'
|
|
import { DocsMobileNav } from '@/components/interfaces/Integrations/DataApi/DocsMobileNav'
|
|
import { DocView } from '@/components/interfaces/Integrations/DataApi/DocView'
|
|
import { generateDocsMenu, getActivePage } from '@/components/layouts/DocsLayout/DocsLayout.utils'
|
|
import { useOpenAPISpecQuery } from '@/data/open-api/api-spec-query'
|
|
import { useIsDataApiEnabled } from '@/hooks/misc/useIsDataApiEnabled'
|
|
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
import { PROJECT_STATUS } from '@/lib/constants'
|
|
|
|
export const DataApiDocsTab = () => {
|
|
const DEFAULT_KEY = { name: 'hide', key: 'SUPABASE_KEY' }
|
|
const { ref: projectRef, page, resource, rpc } = useParams()
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const { projectAuthAll: authEnabled } = useIsFeatureEnabled(['project_auth:all'])
|
|
const isPaused = project?.status === PROJECT_STATUS.INACTIVE
|
|
|
|
const [selectedLang, setSelectedLang] = useState<'js' | 'bash'>('js')
|
|
const [selectedApiKey, setSelectedApiKey] = useState<ShowApiKey>(DEFAULT_KEY)
|
|
|
|
const { isEnabled, isPending: isConfigLoading } = useIsDataApiEnabled({ projectRef })
|
|
|
|
const { data: openApiSpec } = useOpenAPISpecQuery(
|
|
{ projectRef },
|
|
{
|
|
enabled: !!projectRef && !isPaused && isEnabled,
|
|
}
|
|
)
|
|
|
|
const tableNames = useMemo(
|
|
() => (openApiSpec?.tables ?? []).map((table) => table.name),
|
|
[openApiSpec]
|
|
)
|
|
const functionNames = useMemo(
|
|
() => (openApiSpec?.functions ?? []).map((fn) => fn.name),
|
|
[openApiSpec]
|
|
)
|
|
|
|
const activePage = useMemo(() => getActivePage({ page, resource, rpc }), [page, resource, rpc])
|
|
|
|
const docsBasePath = projectRef ? `/project/${projectRef}/integrations/data_api/docs` : undefined
|
|
|
|
const menu = useMemo(() => {
|
|
if (!projectRef) return []
|
|
return generateDocsMenu(projectRef, tableNames, functionNames, { authEnabled }, docsBasePath)
|
|
}, [projectRef, tableNames, functionNames, authEnabled, docsBasePath])
|
|
|
|
if (isConfigLoading) {
|
|
return (
|
|
<div className="flex w-full bg-surface-100 flex-1 items-stretch p-10">
|
|
<ShimmeringLoader className="w-full h-full" />
|
|
</div>
|
|
)
|
|
}
|
|
|
|
if (!isEnabled) {
|
|
return <DataApiDisabledState description="view the documentation" />
|
|
}
|
|
|
|
return (
|
|
<div className="flex w-full bg-surface-100 flex-1 items-stretch">
|
|
<aside className="hidden lg:flex flex-col gap-y-6 w-60 shrink-0 p-10">
|
|
<LangSelector
|
|
selectedLang={selectedLang}
|
|
selectedApiKey={selectedApiKey}
|
|
setSelectedLang={(lang: 'js' | 'bash') => setSelectedLang(lang)}
|
|
setSelectedApiKey={setSelectedApiKey}
|
|
/>
|
|
<DocsMenu activePage={activePage} menu={menu} />
|
|
</aside>
|
|
<div className="flex-1 min-w-0 relative">
|
|
<DocsMobileNav
|
|
activePage={activePage}
|
|
menu={menu}
|
|
selectedLang={selectedLang}
|
|
selectedApiKey={selectedApiKey}
|
|
setSelectedLang={setSelectedLang}
|
|
setSelectedApiKey={setSelectedApiKey}
|
|
/>
|
|
<DocView selectedLang={selectedLang} selectedApiKey={selectedApiKey} />
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|