Files
supabase/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.tsx
T
Charis f7bf7d7ce4 feat(studio): move data api docs to integrations section (#42749)
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
2026-02-12 15:57:44 -05:00

107 lines
3.8 KiB
TypeScript

import { useParams } from 'common'
import { AlertCircle } from 'lucide-react'
import { parseAsString, useQueryState } from 'nuqs'
import { useEffect } from 'react'
import { Alert_Shadcn_, AlertTitle_Shadcn_ } from 'ui'
import {
PageSection,
PageSectionAside,
PageSectionContent,
PageSectionDescription,
PageSectionMeta,
PageSectionSummary,
PageSectionTitle,
} from 'ui-patterns'
import { Input } from 'ui-patterns/DataInputs/Input'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
import { DatabaseSelector } from '@/components/ui/DatabaseSelector'
import { useCustomDomainsQuery } from '@/data/custom-domains/custom-domains-query'
import { useLoadBalancersQuery } from '@/data/read-replicas/load-balancers-query'
import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useStaticEffectEvent } from '@/hooks/useStaticEffectEvent'
import { useDatabaseSelectorStateSnapshot } from '@/state/database-selector'
import { getApiEndpoint } from '@/components/interfaces/Integrations/DataApi/DataApi.utils'
export const DataApiProjectUrlCard = () => {
const { isPending: isLoading } = useSelectedProjectQuery()
const { ref: projectRef } = useParams()
const state = useDatabaseSelectorStateSnapshot()
const [querySource, setQuerySource] = useQueryState('source', parseAsString)
const { data: customDomainData } = useCustomDomainsQuery({ projectRef })
const {
data: databases,
isError,
isPending: isLoadingDatabases,
} = useReadReplicasQuery({ projectRef })
const { data: loadBalancers } = useLoadBalancersQuery({ projectRef })
const syncSelectedDb = useStaticEffectEvent(() => {
if (querySource && querySource !== state.selectedDatabaseId) {
state.setSelectedDatabaseId(querySource)
}
})
useEffect(() => {
syncSelectedDb()
}, [syncSelectedDb, querySource, projectRef])
const selectedDatabase = databases?.find((db) => db.identifier === state.selectedDatabaseId)
const loadBalancerSelected = state.selectedDatabaseId === 'load-balancer'
const replicaSelected = selectedDatabase?.identifier !== projectRef
const endpoint = getApiEndpoint({
selectedDatabaseId: state.selectedDatabaseId,
projectRef,
customDomainData,
loadBalancers,
selectedDatabase,
})
return (
<PageSection className="first:pt-0">
<PageSectionMeta>
<PageSectionSummary>
<PageSectionTitle>API URL</PageSectionTitle>
<PageSectionDescription>
{loadBalancerSelected
? 'RESTful endpoint for querying and managing your databases through your load balancer'
: replicaSelected
? 'RESTful endpoint for querying your read replica'
: 'RESTful endpoint for querying and managing your database'}
</PageSectionDescription>
</PageSectionSummary>
<PageSectionAside>
<DatabaseSelector
additionalOptions={
(loadBalancers ?? []).length > 0
? [{ id: 'load-balancer', name: 'API Load Balancer' }]
: []
}
onSelectId={() => {
setQuerySource(null)
}}
/>
</PageSectionAside>
</PageSectionMeta>
<PageSectionContent>
{isLoading || isLoadingDatabases ? (
<div className="space-y-2">
<ShimmeringLoader />
<ShimmeringLoader className="w-3/4" delayIndex={1} />
</div>
) : isError ? (
<Alert_Shadcn_ variant="destructive">
<AlertCircle size={16} />
<AlertTitle_Shadcn_>Failed to retrieve project URL</AlertTitle_Shadcn_>
</Alert_Shadcn_>
) : (
<Input copy readOnly className="font-mono" value={endpoint} />
)}
</PageSectionContent>
</PageSection>
)
}