https://github.com/apprexp/govsg2oas

A project which aims to convert existing government public-facing APIs into the OpenAPI 3 specs.
https://github.com/apprexp/govsg2oas

oas oas3 oasv3 openapi openapi3 singapore singapore-bus-data singapore-government

Last synced: about 1 month ago
JSON representation

A project which aims to convert existing government public-facing APIs into the OpenAPI 3 specs.

• Host: GitHub
• URL: https://github.com/apprexp/govsg2oas
• Owner: apprexp
• License: apache-2.0
• Created: 2019-11-16T05:42:25.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T08:10:21.000Z (about 2 months ago)
• Last Synced: 2024-10-01T07:01:34.193Z (about 2 months ago)
• Topics: oas, oas3, oasv3, openapi, openapi3, singapore, singapore-bus-data, singapore-government
• Language: TypeScript
• Size: 110 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# GovSG-2-OAS

> **This project is under heavy development. Expect many breaking changes.**

![GitHub](https://img.shields.io/github/license/apprexp/govsg2oas?style=flat-square)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg?style=flat-square)](code-of-conduct.md)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

![OSS Lifecycle](https://img.shields.io/osslifecycle/apprexp/govsg2oas?style=flat-square)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fapprexp%2Fgovsg2oas.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fapprexp%2Fgovsg2oas?ref=badge_shield)

The GovSG-2-OAS aims to document publicly-accessible government APIs into a well-established format: OpenAPI 3.

This is to encourage automatic code generation and increased readability of API documentation across government agencies.

## FAQ

### Can you add Data.gov.sg dynamic datasets?

Currently no. There's already an [official OpenAPI Specification (OAS) 3.0.0](https://raw.githubusercontent.com/datagovsg/datagovsg-datasets/master/documentation/swagger.yml) for those datasets. If there's a new reason for us to maintain our own version (e.g. it's no longer maintained), then [open an issue](https://github.com/apprexp/govsg2oas/issues/new) so taht we can look into it.

### Can you add X dataset?

We're always open to accepting new datasets! [open a new issue](https://github.com/apprexp/govsg2oas/issues/new) and we'll take a look at it.

### Why are you maintaining these?

The mission of AppRExp is to develop tools to serve a purpose of making the lives of youths in Singapore better. We believe that this project will help us accomplish this goal.

### How often will you update this?

While we cannot make any guarantee, we promise it will be updated on a best-effort basis. We will usually respond to new issues within 3 days. Otherwise, you may reach out to [Rifa on Twitter](https://twitter.com/achrinza) whose spearheading the project.

## Contributors

* [Rifa Achrinza](https://github.com/achrinza) (Main contributor)

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fapprexp%2Fgovsg2oas.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fapprexp%2Fgovsg2oas?ref=badge_large)