From dd60369fe9730c5b5e2e3e044778b0676ac67e95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kristj=C3=A1n=20Ingi=20Mikaelsson?= Date: Wed, 1 May 2013 00:14:57 +0000 Subject: [PATCH] Readme updated --- README.md | 75 +++++++++++++++++++--------------------------------- package.json | 2 +- 2 files changed, 28 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 5fb9d280..6b14a8c2 100644 --- a/README.md +++ b/README.md @@ -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/) @@ -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. - diff --git a/package.json b/package.json index e6a82685..fbf92667 100644 --- a/package.json +++ b/package.json @@ -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" } }