Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myconsciousness/resas
A most easily usable RESAS API wrapper in Dart. With this library, you can easily integrate your application with the RESAS API.
https://github.com/myconsciousness/resas
api apiwrapper dart flutter japan library pubdev resas statistics
Last synced: 4 days ago
JSON representation
A most easily usable RESAS API wrapper in Dart. With this library, you can easily integrate your application with the RESAS API.
- Host: GitHub
- URL: https://github.com/myconsciousness/resas
- Owner: myConsciousness
- License: bsd-3-clause
- Created: 2021-12-20T00:44:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-16T08:32:30.000Z (about 3 years ago)
- Last Synced: 2024-10-19T09:19:06.976Z (3 months ago)
- Topics: api, apiwrapper, dart, flutter, japan, library, pubdev, resas, statistics
- Language: Dart
- Homepage: https://pub.dev/packages/resas
- Size: 260 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**_A most easily usable RESAS API wrapper library in Dart!_**
[](https://pub.dev/packages/resas)
- [1. About](#1-about)
- [1.1. What Is RESAS?](#11-what-is-resas)
- [1.2. Introduction](#12-introduction)
- [1.2.1. Install Library](#121-install-library)
- [1.2.2. Import It](#122-import-it)
- [1.2.3. Use Resas](#123-use-resas)
- [1.3. License](#13-license)
- [1.4. More Information](#14-more-information)
# 1. About
`Resas` is an open-sourced Dart library.
With this library, you can easily integrate your application with the [RESAS API](https://opendata.resas-portal.go.jp/docs/api/v1/index.html).
`Resas` is an unofficial library.
## 1.1. What Is RESAS?
It is a system that aggregates and visualizes public and private sector big data on industrial structure, demographics, and human flows in Japan.
The Regional Economic Analysis System (RESAS) is provided by the Ministry of Economy, Trade and Industry (METI) and the Cabinet Secretariat (Secretariat of the Headquarters for the Creation of New Town, New Human Resources and New Work) to support various initiatives for regional development from an information perspective.
It is widely used by local government officials and people from various fields who are interested in regional revitalization to plan, implement, and verify effective measures.
## 1.2. Introduction
### 1.2.1. Install Library
**_With Dart:_**
```terminal
dart pub add resas
```
**_With Flutter:_**
```terminal
flutter pub add resas
```
### 1.2.2. Import It
```dart
import 'package:resas/resas.dart';
```
### 1.2.3. Use Resas
In order to use the RESAS API, you need an API key issued on the [official website](https://opendata.resas-portal.go.jp/form.html). Generate the API key from the following site and pass it to the constructor of the [Resas](https://pub.dev/documentation/resas/latest/resas/Resas-class.html) class.
```dart
import 'package:resas/resas.dart';
void main() async {
final resas = Resas.connectWith(
key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', // ← Replace with your API key.
);
// Once the instance is created, you can easily access the API by simply calling the method.
final prefecturesResponse = await resas.common.prefectures();
// It's easy to handle response status.
if (prefecturesResponse.status.isNotOk) {
// Do something when status is not OK (200).
return;
}
print(prefecturesResponse);
final citiesResponse = await resas.common.cities(
prefectureCode: prefecturesResponse.result![0].code,
);
print(citiesResponse);
final oldCitiesResponse = await resas.common.oldCities(
prefectureCode: prefecturesResponse.result![0].code,
cityCode: citiesResponse.result![0].code,
);
print(oldCitiesResponse);
}
```
## 1.3. License
```license
Copyright (c) 2021, Kato Shinya. All rights reserved.
Use of this source code is governed by a
BSD-style license that can be found in the LICENSE file.
```
## 1.4. More Information
`Resas` was designed and implemented by **_Kato Shinya_**.
- [Creator Profile](https://github.com/myConsciousness)
- [License](https://github.com/myConsciousness/resas/blob/main/LICENSE)
- [API Document](https://pub.dev/documentation/resas/latest/resas/resas-library.html)
- [Release Note](https://github.com/myConsciousness/resas/releases)
- [Bug Report](https://github.com/myConsciousness/resas/issues)