Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
kristjanmik committed May 1, 2013
1 parent 90e0ff9 commit dd60369
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 49 deletions.
75 changes: 27 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,35 @@ Tilgangur [Apis.is](http://apis.is) er að veita forriturum og áhugamönnum að

**Ekki hika við að hjálpa til, öll þekking og hjálp er vel þegin!**

##Núverandi gögn sem hægt er að fá á apis.is
+ [Strætógögn](http://apis.is#bus)
+ Mögulegar leiðir milli tveggja staða
+ Hægt er að leita út frá GPS-hnitum eða götunöfnum.
+ Komutímar og brotfaratímar
+ Kemur með nokkrar tillögur að leiðum
+ Rauntímagögn um staðsetningu strætóa
+ [Símaskrá](http://apis.is#phone)
+ Leit
+ Hægt að leita út frá nafni eða símanúmeri
+ Skilar slóð á .vcf upplýsingakort fyrir einstakling
+ Þegar vélbúnaðarkostur verður uppfærður bætast nokkrir áhugaverðir hlutir hér.
+ [Gjaldmiðlar](http://apis.is#currency)
+ Listi yfir alla gjaldmiðla
+ Sýnir heiti gjaldmiðla, breytingar dagsins í dag ásamt kaup og sölugengi(fer eftir hvaða upplýsingaveita er valin)
+ [SMS](http://apis.is#sms)
+ Sendir smáskilaboð á tilgreint númer
+ Þessi endapunktur er lokaður eins og stendur þar sem bent var á að það væri ekki æskilegt að hafa hann opinn. Hafðu samband ef að þú villt aðgang.
+ [Fyrirtæki](http://apis.is#company)
+ Skilar upplýsingum um fyrirtæki
+Hægt er að leita út frá nafni, heimilsfangi, kennitölu eða vasknúmeri.
##Prófanir
Hægt er að keyra integration tests fyrir hluta af vefþjónustunum með því að nota skipunina:

node_modules/mocha/bin/mocha test/integration

## Gögn sem væri sniðugt að bæta við sem endapunktum:
##Hvað þarf að gera til að bæta við endapunkt?
Endapunktar virka allir núna eingöngu þannig að um leið og það er kallað í hann þá sækir hann og parsar viðeigandi síðu eða API annarsstaðar og skilar útkomu.

###Skref fyrir skref:
+ Best er að skoða einn endapunktinn til að sjá hvernig aðrir hafa verið innleiddir
+ Bæta við möppu í `endpoints/` undir viðeigandi nafni
+ Þar ætti að vera `index.js` skrá, sem exportar function sem heitir `setup`, hann tekur við einu argumenti `server`. Þar þarftu að binda þá slóð sem þú vilt að endapunkturinn hlusti á.

####Dæmi (í endpoints/kaboom):

exports.setup = function(server){
server.get({path: '/kaboom', version: '1.0.0'}, function(request, response, next){
// hér gerast galdrarnir
});
};

####Hægt er að lesa um hvernig hægt er að meðhöndla bæði request og response [hérna](http://mcavage.github.io/node-restify)

+ Endapunktum er, enn sem komið er, frjálst að bæta við requires() modulum að þörf.
+ Best væri ef hver endapunktur mundi skrásetja hvernig maður notar endapunktinn, ss. hvaða parameters hann tekur við osfrv
+ Það væri frábært að bæta við unit testum fyrir parta úr endapunktunum, en enn sem komið er gerir enginn annar endapunktur það.
+ Lágmark er að bæta við [integration testi](http://en.wikipedia.org/wiki/Integration_testing) fyrir endapunktinn. Það er gert með því að bæta við möppu inn í endapunktinum sem heitir `tests`, og þar inni skal vera skrá sem heitir `integration_test.js`. Hægt er að líta á aðra endapunkta fyrir dæmi um hvernig það er gert.

## Gögn sem hægt er að vinna úr og hugsanlega bæta við sem endapunkt:

+ Flug:
+ [kefairport.is](http://www.kefairport.is/)
Expand Down Expand Up @@ -59,29 +64,3 @@ Tilgangur [Apis.is](http://apis.is) er að veita forriturum og áhugamönnum að
+ [arnastofnun.is/page/gagnasofn](http://arnastofnun.is/page/gagnasofn)
+ [opingogn.net/wiki](http://opingogn.net/wiki/)

##Prófanir
Hægt er að keyra integration tests fyrir hluta af vefþjónustunum með því að nota skipunina:

node_modules/mocha/bin/mocha test/integration

##Hvað þarf að gera til að bæta við endapunk
Endapunktar virka allir núna eingöngu þannig að um leið og gert er request í hann þá sækir hann og parsar viðeigandi síðu eða API annarsstaðar og skilar útkomu.

###Skref fyrir skref:
+ Best er að skoða einn endapunktinn til að sjá hvernig aðrir hafa verið implementaðir
+ Bæta við möppu í `endpoints/` undir viðeigandi nafni
+ Þar ætti að vera `index.js` skrá, sem exportar function sem heitir `setup`, hann tekur við einu argumenti `server`. Þar þarftu að binda þá slóð sem þú vilt að endapunkturinn hlusti á.

####Dæmi (í endpoints/kaboom):

exports.setup = function(server){
server.get({path: '/kaboom', version: '1.0.0'}, function(){
// hér gerast galdrarnir
});
};

+ Endapunktum er, enn sem komið er, frjálst að bæta við requires() modulum að þörf.
+ Best væri ef hver endapunktur mundi skrásetja hvernig maður notar endapunktinn, ss. hvaða parameters hann tekur við osfrv
+ Það væri frábært að bæta við unit testum fyrir parta úr endapunktunum, en enn sem komið er gerir enginn annar endapunktur það.
+ Lágmark er að bæta við integration testi fyrir endapunktinn. Það er gert með því að bæta við möppu inn í endapunktinum sem heitir `tests`, og þar inni skal vera skrá sem heitir `integration_test.js`. Hægt er að líta á aðra endapunkta fyrir dæmi um hvernig það er gert.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@
"isn2wgs": "0.0.1"
},
"scripts":{
"test": "find ./test -name '*.js' | xargs mocha -R spec"
"test": "node_modules/mocha/bin/mocha test/integration"
}
}

0 comments on commit dd60369

Please sign in to comment.