Tellurian snabbklocka

Allmäna diskussioner och information
Användarvisningsbild
StefanFjällemark
Inlägg: 1338
Blev medlem: 2014-09-01, 07:35
Ort: Stenungsund på Västkusten

Re: Tellurian snabbklocka

Inlägg av StefanFjällemark »

MikaelB skrev: 2020-06-04, 12:21 Tack för länken till projektets Github repo. Ang API - dokumentation kan jag kika på stöd till Swagger om intresse finns för det?
- Mikael
Om du har lust att implementera detta med hjälp av Swashbuckle så varsågod att komma med en pull-request! Med Swashbuckle blir det väldigt enkelt, då den baseras på XML-dokumentation av koden. Man kan även lägga till i en api-contoller vilka felkoder som returneras.

https://docs.microsoft.com/en-us/aspnet ... ual-studio
Hälsningar från Stefan på västkusten :geek:
Ordförande i Svenskt Modulforum och medlem i FREMO, VMJF och MJF Rälsbiten
Användarvisningsbild
StefanFjällemark
Inlägg: 1338
Blev medlem: 2014-09-01, 07:35
Ort: Stenungsund på Västkusten

Re: Tellurian snabbklocka

Inlägg av StefanFjällemark »

Nicke skrev: 2020-06-03, 20:10 Fråga 1:
Om jag fattat det rätt, vilket tyvärr inte verkar vara fallet, så borde jag få ett svar från:
https://telluriantrainsclocksappserver. ... me/Default
i något som liknar JSON.
Istället får jag bara: "Sorry, there's nothing at this address!."
Vad har jag missat?
Jag har fått detta också, och jag tror det beror på att jag hade Appen installerad lokalt. Så kör med en annan webbläsare eller använd ett api-verktyg som t.ex Postman, eller anropa via din kod.
Nicke skrev: 2020-06-03, 20:10 Fråga 2:
"The API-key is configured in the servers settings."
Var?
Om du checkat ut koden, leta efter en fil som heter appsettnings.json. Molnversionen har 'password' som lösenord för administration av klockan.
Hälsningar från Stefan på västkusten :geek:
Ordförande i Svenskt Modulforum och medlem i FREMO, VMJF och MJF Rälsbiten
Användarvisningsbild
StefanFjällemark
Inlägg: 1338
Blev medlem: 2014-09-01, 07:35
Ort: Stenungsund på Västkusten

Re: Tellurian snabbklocka

Inlägg av StefanFjällemark »

Version 2.1.3 släppt i dag. Nyheter i denna version:
  • Uppdaterad README med bland annat mer detaljer om hur man kör appen lokalt.
  • Uppdaterad API-specifikation.
  • Lagt till 'kaffepaus' som anledning till paus.
  • Lagt till 'urspårning' och 'annan orsak' som anledning att stoppa klockan.
  • Endast administratören eller den som stoppat klockan kan starta den igen.
Hälsningar från Stefan på västkusten :geek:
Ordförande i Svenskt Modulforum och medlem i FREMO, VMJF och MJF Rälsbiten
Användarvisningsbild
MikaelB
Inlägg: 432
Blev medlem: 2012-06-26, 23:53
Ort: Helsingborg
Kontakt:

Re: Tellurian snabbklocka

Inlägg av MikaelB »

StefanFjällemark skrev: 2020-06-04, 15:36
MikaelB skrev: 2020-06-04, 12:21 Tack för länken till projektets Github repo. Ang API - dokumentation kan jag kika på stöd till Swagger om intresse finns för det?
- Mikael
Om du har lust att implementera detta med hjälp av Swashbuckle så varsågod att komma med en pull-request! Med Swashbuckle blir det väldigt enkelt, då den baseras på XML-dokumentation av koden. Man kan även lägga till i en api-contoller vilka felkoder som returneras.

https://docs.microsoft.com/en-us/aspnet ... ual-studio
YES, ska ha tre veckor sem nu först bara. Lovade min fru att hon skulle få se mer än min ryggtavla ett tag nu :oops:

- Mikael
Nicke
Inlägg: 832
Blev medlem: 2012-05-09, 02:11

Re: Tellurian snabbklocka

Inlägg av Nicke »

StefanFjällemark skrev: 2020-06-04, 15:47 Version 2.1.3 släppt i dag. Nyheter i denna version:
  • Uppdaterad README med bland annat mer detaljer om hur man kör appen lokalt.
  • Uppdaterad API-specifikation.
  • Lagt till 'kaffepaus' som anledning till paus.
  • Lagt till 'urspårning' och 'annan orsak' som anledning att stoppa klockan.
  • Endast administratören eller den som stoppat klockan kan starta den igen.
Tack för de uppdateringarna !
Nu har jag fungerande test-scripts i Python för start,stop och läsa tid och status :)

Det jag funderar lite över är det responsen man får.
Start och stopp verkar ge 200 om allt går bra (vilket ju är som det ska) men ingen övrig text. Stämmer det?
Om man skriver fel i GetTime-requesten (dock inte addressen, för då kommer man ju inte fram, utan i senare delan) så får man en infosida tillbaka i html.
Det är ju snyggt om man kör i en browser, men kanske inte så logiskt för ett API? Dessutom får man reasoncode 200 även i detta fallet, så koden som ska parsa JSON tror att anropet gick bra, men inte är det JSON som returnerats. En 400 känns mer passande, samt ett meddelande om vad som är fel och/eller en hänvisning till infosidan.

Inget akut, det funkar ju, men du kan väl fundera på det när du gör nästa release?
Nicke
Inlägg: 832
Blev medlem: 2012-05-09, 02:11

Re: Tellurian snabbklocka

Inlägg av Nicke »

Elmis skrev: 2020-06-02, 19:27 Begreppet "swedish fika" är väletablerat i den engelskspråkiga delen av världen.
Var försiktig med "fika" (eller "fica") i Italien...
Användarvisningsbild
MikaelB
Inlägg: 432
Blev medlem: 2012-06-26, 23:53
Ort: Helsingborg
Kontakt:

Re: Tellurian snabbklocka

Inlägg av MikaelB »

Nicke skrev: 2020-06-05, 09:48 Det är ju snyggt om man kör i en browser, men kanske inte så logiskt för ett API?
Ett API är ju där för att du ska kunna köra i precis vad du vill (inte tvunget en webbläsare) och använda respektive resurs på just det viset du själv vill använda den.

- Mikael
Nicke
Inlägg: 832
Blev medlem: 2012-05-09, 02:11

Re: Tellurian snabbklocka

Inlägg av Nicke »

Ja, håller med, men min uppfattning (som kanske inte alla håller med om, vem vet) är att en html-sida i första hand är gjord för att visas i en browser, medan ett API i första hand är avsett för ett program/script.
(Det heter ju Application Programming Interface).
Alltså tycker jag det är logiskt att ett API svarar med ett format avsett att läsas av en application, lämpligen XML eller JSON.
Jag vill inte sträcka mig till att det är fel, men jag tycker det är ologiskt att clock-apiet svarar med JSON om requesten går bra, men svarar med HTML om requesten är felaktig.

(och dessutom med response-code 200 (OK) i båda fallen. (Gäller endast Time, inte start/stop))
Användarvisningsbild
StefanFjällemark
Inlägg: 1338
Blev medlem: 2014-09-01, 07:35
Ort: Stenungsund på Västkusten

Re: Tellurian snabbklocka

Inlägg av StefanFjällemark »

Nicke skrev: 2020-06-05, 16:21 Ja, håller med, men min uppfattning (som kanske inte alla håller med om, vem vet) är att en html-sida i första hand är gjord för att visas i en browser, medan ett API i första hand är avsett för ett program/script.
(Det heter ju Application Programming Interface).
Alltså tycker jag det är logiskt att ett API svarar med ett format avsett att läsas av en application, lämpligen XML eller JSON.
Jag vill inte sträcka mig till att det är fel, men jag tycker det är ologiskt att clock-apiet svarar med JSON om requesten går bra, men svarar med HTML om requesten är felaktig.
(och dessutom med response-code 200 (OK) i båda fallen. (Gäller endast Time, inte start/stop))
Anledningen till att man får HTML just nu är att alla anrop som inte kan routas till API:et hamnar på appens sida som säger att det inte finns något där. Jag skall undersöka om det finns något sätt att routa alla anrop till /api/ routas till en API-felhanterare. Detta är inget prioriretat, men vill någon lista ut hur man gör så är du välkommen med en pull-request.
Hälsningar från Stefan på västkusten :geek:
Ordförande i Svenskt Modulforum och medlem i FREMO, VMJF och MJF Rälsbiten
Nicke
Inlägg: 832
Blev medlem: 2012-05-09, 02:11

Re: Tellurian snabbklocka

Inlägg av Nicke »

Ah, förstår.

Som jag skrev längre upp är det inte akut utan bara en synpunkt/önskemål till nästa release :)
Skriv svar

Återgå till "Allmänt"