# spring-guides/gs-rest-service

Building a RESTful Web Service :: Learn how to create a RESTful web service with Spring.

Repository: https://github.com/spring-guides/gs-rest-service
Canonical: https://ross.abutalabs.com/products/gs-rest-service
Homepage: https://spring.io/guides/gs/rest-service/
Language: Java
License: Apache-2.0
License Family: permissive
Topics: spring-boot
Last push: 2026-07-01T10:49:32+00:00

## Health v2 (maintenance only)
Score: 73/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 90, release rhythm 35, longevity 100
- inputs: {"age_days": 4891, "days_push": 63, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_readme
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1471, forks 2723 (observed 2026-08-28T04:04:49.242258+00:00)

## What it is
An official Spring getting-started guide that walks developers through building a simple 'Hello, World' RESTful web service with Spring Boot. It includes complete and initial project code for Gradle and Maven, demonstrating @RestController, JSON responses, and query parameters.

## Use cases
- learn how to create a RESTful web service with Spring
- build a hello world REST API in Spring Boot
- return JSON from a Spring Boot endpoint
- get started with Spring Boot web development
- example of handling query parameters in a Spring controller
- starter project for a Spring Boot REST service

## When to choose
- you are new to Spring or Spring Boot and want a guided tutorial
- you need a minimal working example of a Spring REST endpoint
- you want official, maintained sample code to scaffold a first Spring Boot web service

## When to avoid
- you need production-ready REST service architecture beyond a hello-world example
- you are looking for a framework or library to add as a dependency rather than a tutorial
- you work outside the JVM/Spring ecosystem

## Facets
- artifact type: learning-resource
- maturity: active
- function: http-server, api-framework
- domain: web-development, backend, apis, tutorials, developer-tools
- platform: jvm, cross-platform
- tags: spring-boot, rest, tutorial, getting-started-guide, hello-world, spring-framework

## Member repositories
- spring-guides/gs-rest-service (main) score 73

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:49.242258+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:34:46.783552+00:00, confidence not recorded.
  - homepage: https://spring.io/guides/gs/rest-service/ (fetched 2026-08-29T11:42:39.416858+00:00, sha eaa6d73d3a70)
  - site_page: https://spring.io/quickstart (fetched 2026-08-29T11:42:39.422161+00:00, sha fc64dd950363)
  - site_page: https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/RestController.html (fetched 2026-08-29T11:42:39.425632+00:00, sha e92242839e6a)
  - site_page: https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/http/converter/json/JacksonJsonHttpMessageConverter.html (fetched 2026-08-29T11:42:39.427309+00:00, sha 6e7f08b89f0d)
  - site_page: https://spring.io/guides/gs/testing-restdocs (fetched 2026-08-29T11:42:39.430603+00:00, sha 1156992cba1c)
  - site_page: https://enterprise.spring.io (fetched 2026-08-29T11:42:39.420119+00:00, sha 85ac7d6d5114)
  - site_page: https://enterprise.spring.io/lts-releases (fetched 2026-08-29T11:42:39.423968+00:00, sha 3251cc8760b6)
- Data as of 2026-08-30T08:39:29.467469+00:00.