Skip to content

Commit e88a81f

Browse files
authored
Migrate: API routes from /api to /v1 (#14)
1 parent 51b0ab1 commit e88a81f

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -99,27 +99,30 @@ A RESTful API for Tanzania location data including countries, regions, districts
9999
## API Endpoints
100100
101101
### Countries
102-
- `GET /api/countries` - Get all countries
103-
- `GET /api/countries/:id` - Get country by ID
102+
- `GET /v1/countries` - Get all countries
103+
- `GET /v1/countries/:id` - Get country by ID
104104
105105
### Regions
106-
- `GET /api/regions` - Get all regions
107-
- `GET /api/regions/:regionCode` - Get region by code
108-
- `GET /api/regions/:regionCode/districts` - Get districts in a region
106+
- `GET /v1/regions` - Get all regions
107+
- `GET /v1/regions/:regionCode` - Get region by code
108+
- `GET /v1/regions/:regionCode/districts` - Get districts in a region
109109
110110
### Districts
111-
- `GET /api/districts` - Get all districts
112-
- `GET /api/districts/:districtCode` - Get district by code
113-
- `GET /api/districts/:districtCode/wards` - Get wards in a district
111+
- `GET /v1/districts` - Get all districts
112+
- `GET /v1/districts/:districtCode` - Get district by code
113+
- `GET /v1/districts/:districtCode/wards` - Get wards in a district
114114
115115
### Wards
116-
- `GET /api/wards` - Get all wards
117-
- `GET /api/wards/:wardCode` - Get ward by code
118-
- `GET /api/wards/:wardCode/places` - Get places in a ward
116+
- `GET /v1/wards` - Get all wards
117+
- `GET /v1/wards/:wardCode` - Get ward by code
118+
- `GET /v1/wards/:wardCode/places` - Get places in a ward
119119
120120
### Places
121-
- `GET /api/places` - Get all places
122-
- `GET /api/places/:id` - Get place by ID
121+
- `GET /v1/places` - Get all places
122+
- `GET /v1/places/:id` - Get place by ID
123+
124+
### Search
125+
- `GET /v1/search?q=nzuguni` - Fulltext search for locations by name
123126
124127
## Running Tests
125128

0 commit comments

Comments
 (0)