skills.rest
navikt
naviktOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-design

Design REST API patterns for Nav services with RFC 7807 and OpenAPI conventions.

1|1|Updated Feb 2, 2026
Search Tags:#versioning#openapi#backend#rest#error-handling#api-design
One-click install
npx skills add https://github.com/navikt/watson-sak-frontend --skill api-design-navikt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/navikt/watson-sak-frontend/tree/main/.opencode/skills/api-design
Command: npx skills add https://github.com/navikt/watson-sak-frontend --skill api-design-navikt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardizes REST API design for Nav services to improve consistency, interoperability, and maintainability across teams.

Core Features & Use Cases

  • Guidelines for resource naming, URL structure, and versioning.
  • Standardized error handling using RFC 7807 Problem Details.
  • OpenAPI-driven design and documentation scaffolding for Nav services.

Quick Start

Draft a minimal OpenAPI spec for a new resource, following the conventions outlined in this guide.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API with consistent naming and URL conventions?▼

REST API design standardizes resource naming, URL structure, and versioning conventions to improve interoperability across backend services. It enforces consistent URL design and provides OpenAPI annotations guidance for Nav services.

What is the best way to handle REST API errors using RFC 7807?▼

REST API error handling uses RFC 7807 Problem Details to standardize error responses across services. This ensures consistent error reporting formats, improving maintainability and predictable client-side error handling.

How do I scaffold OpenAPI documentation for a new backend service?▼

OpenAPI-driven design scaffolds documentation by drafting a minimal OpenAPI spec for a new resource. It provides OpenAPI annotations guidance to ensure your REST API documentation follows established conventions.

What versioning strategy should I use for a Nav REST API?▼

REST API versioning applies standardized guidelines to URL structure and resource naming for Nav services. It enforces consistent versioning conventions across backend services to maintain interoperability across teams.

Do I need specific dependencies to apply these REST API standards?▼

No external dependencies are required to apply these REST API standards. The design guidelines for resource naming, error handling, and OpenAPI conventions operate independently to standardize Nav backend services.

When should I standardize error responses with RFC 7807 in my API?▼

Standardize error responses with RFC 7807 when you need consistent error handling across multiple Nav backend services. It enforces uniform error formats, improving maintainability and interoperability across distributed teams.

Related Skills

Explore More Software Engineering Skills→
pkuppenspkuppens
1

api-design

Enforce REST conventions, versioning, and OpenAPI documentation for API endpoints.

Community
Intermediate
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate
PriyanshKuniyalPriyanshKuniyal

nodejs-backend-patterns

Guide building Node.js backend services with Express or Fastify.

Community
Advanced
qa-amanqa-aman
19

api-design

Define and validate REST and GraphQL API contracts with schemas and versioning.

Community
Intermediate