79 lines
4.1 KiB
Markdown
79 lines
4.1 KiB
Markdown
# navitia/types is a library for working with types returned by the [Navitia](navitia.io) API. [](https://godoc.org/github.com/govitia/navitia/types)
|
||
|
||
Package types implements support for the types used in the Navitia API (see doc.navitia.io), simplified and modified for idiomatic Go use.
|
||
|
||
This is navitia/types v0.2. It is not API-Stable, and won't be until the v1 release of navitia, but it's getting closer !
|
||
This package was and is developped as a supporting library for the [navitia API client](https://github.com/govitia/navitia) but can be used to build other navitia API clients.
|
||
|
||
## Install
|
||
|
||
Simply run `go get -u github.com/govitia/navitia/types`.
|
||
|
||
## Coverage
|
||
|
||
Preview of the supported types, see [the doc](https://godoc.org/github.com/govitia/navitia-types) for more information, and the [navitia.io doc](http://doc.navitia.io) for information about the remote API.
|
||
|
||
|Type Name|Description|Navitia Name|
|
||
|---|---|---|
|
||
|[`Journey`](https://godoc.org/github.com/govitia/navitia-types#Journey)|A journey (X-->Y)|"journey"|
|
||
|[`Section`](https://godoc.org/github.com/govitia/navitia-types#Section)|A section of a `Journey`|"section"|
|
||
|[`Region`](https://godoc.org/github.com/govitia/navitia-types#Region)|A region covered by the API|"region"|
|
||
|[`Isochrone`](https://godoc.org/github.com/govitia/navitia-types#Region)|A region covered by the API|"isochrone"|
|
||
|[`Container`](https://godoc.org/github.com/govitia/navitia-types#Container)|This contains a Place or a PTObject|"place"/"pt_object"|
|
||
|[`Place`](https://godoc.org/github.com/govitia/navitia-types#Place)|Place is an empty interface, by convention used to identify an `Address`, [`StopPoint`](https://godoc.org/github.com/govitia/navitia-types#StopPoint), [`StopArea`](https://godoc.org/github.com/govitia/navitia-types#StopArea), [`POI`](https://godoc.org/github.com/govitia/navitia-types#POI), [`Admin`](https://godoc.org/github.com/govitia/navitia-types#Admin) & [`Coordinates`](https://godoc.org/github.com/govitia/navitia-types#Coordinates).|
|
||
|[`PTObject`](https://godoc.org/github.com/govitia/navitia-types#Place)|PTObject is an empty interface by convention used to identify a Public Transportation object|
|
||
|[`Line`](https://godoc.org/github.com/govitia/navitia-types#Line)|A public transit line.|"line"|
|
||
|[`Route`](https://godoc.org/github.com/govitia/navitia-types#Route)|A specific route within a `Line`.|"route"|
|
||
|
||
And others, such as [`Display`](https://godoc.org/github.com/govitia/navitia-types#Display) ["display_informations"], [`PTDateTime`](https://godoc.org/github.com/govitia/navitia-types#PTDateTime) ["pt-date-time"], [`StopTime`](https://godoc.org/github.com/govitia/navitia-types#StopTime) ["stop_time"]
|
||
|
||
## Getting started
|
||
|
||
```golang
|
||
import (
|
||
"fmt"
|
||
|
||
"github.com/govitia/navitia/types"
|
||
)
|
||
|
||
func main() {
|
||
data := []byte{"some journey's json"}
|
||
var j types.Journey
|
||
_ = j.UnmarshalJSON(data)
|
||
}
|
||
```
|
||
|
||
### Going further
|
||
|
||
Obviously, this is a very simple example of what navitia/types can do, [check out the documentation !](https://godoc.org/github.com/govitia/navitia/types)
|
||
|
||
## What's new in v0.2
|
||
|
||
- Merge back into the `navitia` tree !
|
||
- `Container` is now a type that can be used as a Place Container or as a PTObject Container, which helps everyone!
|
||
- No more `String` methods
|
||
- Better unmarshalling, including better error handling, along with better testing
|
||
- Benchmarks !
|
||
- `Disruption` support, along with what it entails.
|
||
- Rename `JourneyStatus` to `Effect`
|
||
- And others ! See `git log` for more information !
|
||
|
||
## TODO
|
||
|
||
### Documentation
|
||
|
||
- Update `readme.md` to reflect new changes
|
||
- Add links to the doc.navitia.io documentation to every type
|
||
|
||
### Testing
|
||
|
||
- `(*PTDateTime).UnmarshalJSON`
|
||
- `ErrInvalidPlaceContainer.Error`
|
||
- `Equipment.Known`
|
||
- Every Type should have at least one file to be tested against
|
||
- Globalise mutual code in unmarshal testers
|
||
|
||
## Footnotes
|
||
|
||
I made this project as I wanted to explore and push my go skills, and I'm really up for you to contribute ! Send me a pull request and/or contact me if you have any questions! ( [@aabizri](https://twitter.com/aabizri) on twitter)
|