[es] - Dokumentacija Web Servisa

DanN
Dan Ninic
Chicago, USA

Član broj: 12625
Poruke: 8
140.212.205.*

Profil

^{01.08.2003. u 21:55 - pre 252 meseci}

Imam pitanje na temu dokumentacije Web Servisa:

Napravio sam Web Service koji sadrzi odredjen broj metoda/operacija. Kada startujem Web Service (na primer http://localhost/ProstFolder/prost.asmx sa teme FAQ Web Servisi) dobijem poruku "The following operations are supported..." i onda listu operacija. Medjutim, kada kliknem na neku operaciju, ne dobijem Test kao u "Prost" primeru, nego samo Soap prevod (WSDL). Kako sam shvatio, to je zbog toga sto za argumente operacija koristim i slozene strukture a ne samo proste (kao na pr. string).

Sada pitanje: Da li neko zna kako bih moga da u taj Web Service dodam i neki user-friednly, ali automatski kreiran help ili opis operacije ukljucujuci i opis argumenata? Ono sto sam do sada uspeo je da uz svaku operaciju u source file-u (file iz koga .asmx cita kod) dodam opis same operacije pre definicije same operacije (na pr. <WebMethod(Description:="Ova operacija sluzi za to i to.")>). Ono sto bih hteo da izbegnem je da opisujem i svaki parametar ponaosob, a i opis operacije moze da bud3 samo jedan red, nego da nadjem nacin da uz deklaraciju parametara dodam i njihov opis, i onda, kada kliknem na samu operaciju, umesto (ili uz) SOAP poruke dobijem i lep opis parametara. Gledajuci source code koji predstavlja u browseru .asmx file (WSDL parametar), zakljucio sam da on dinamicki kreira SOAP poruku, pa bih teoretski pre nego sto je prikazana, mogao da napravim neki XML reader program koji ce da pretvori SOAP poruku u ono sto ja hocu, ali pretpostavljam da ima i pametniji nacin, nekako da promenim wsdlHelpGenerator, ali opet stoji pitanje kako da u asmx code stavim opis parametra.
BTW, sve se desava u MS okruzenju.

Da li neko ima neku ideju i izvinjavam se na rogobatnosti.

Pozdrav,
Dan

Odgovor na temu

Dragi Tata
Malo ispod Kanade

Član broj: 1958
Poruke: 3906
199.171.112.*

+6 Profil

Re: Dokumentacija Web Servisa

^{01.08.2003. u 22:12 - pre 252 meseci}

Čekaj, može li malo jasnije?

Želeo bi da ti se WebMethod.Description automatski kreira na osnovu deklaracije metoda? Ili nešto drugo?

IOCC

Odgovor na temu

DanN
Dan Ninic
Chicago, USA

Član broj: 12625
Poruke: 8
140.212.205.*

Profil

Re: Dokumentacija Web Servisa

^{01.08.2003. u 22:51 - pre 252 meseci}

Ono sto bih ja hteo je da uz Web Service utomatski kreiram i user-friendly help.

Znaci kada neko otvori http://localhost/ProstFolder/prost.asmx stranu i vidi operaciju Prost, kada klikne na nju ne dobije SOAP prevod nego user-friendly opis operacije sa opisom svih parametara.

U medjuvremenu sam shvatio da bih za to trebalo da izmenim DefaultWsdlHelpGenerator.aspx file ili da kreiram novi, i da izmenim machine.config file, pa da wsdlHelpGenerator uputim na moj help generator. Ako bih i to uspeo da uradim (treba da naucim kako se pise u asp jeziku, ali to je tehnicki problem), i dalje mi nije jasno kako da u sorce code ubacim opis argumenata operacije.

WebMethod.Description sam pomenuo kao primer kako mogu da opisem samu operaciju, a i ceo Web Service. Ali ne i argumente.

Nadam se da je malo jasnije...

Odgovor na temu

byTer

Član broj: 10936
Poruke: 1221
*.ptt.yu

ICQ: 47761626

Profil

Re: Dokumentacija Web Servisa

^{02.08.2003. u 03:15 - pre 252 meseci}

Pa dodaj funkcije koje ce da budu userfriendly help. Mislim da drugacije nije moguce...

Odgovor na temu

Dragi Tata
Malo ispod Kanade

Član broj: 1958
Poruke: 3906
..g-c5300-3.dialup.nethere.net

+6 Profil

Re: Dokumentacija Web Servisa

^{02.08.2003. u 03:54 - pre 252 meseci}

Ma ne, ako sam razumeo dobro fora je u tome da onaj aspx fajl koji generiše help nekako sam prouči koji su parametri funkcija, da ih iskomentariše i prikaže korisniku. Mislim da sve to jednostavno ne vredi truda.

IOCC

Odgovor na temu

DanN
Dan Ninic
Chicago, USA

Član broj: 12625
Poruke: 8
140.212.205.*

Profil

Re: Dokumentacija Web Servisa

^{04.08.2003. u 17:50 - pre 252 meseci}

Tacno to - da onaj aspx file koji generise help sam prouci koji su parametri i opise ih na user-friendly nacin. U sustini, on to vec sam radi, a help prikaze u SOAP formatu, tako da bi ja trebalo da naucim kako da izmenim taj format. A pretpostavljam da ako postoji "Description" attribute za Web Service i za pojedinacne operacije, onda mora da postoji i nesto slicno za same argumente. Samo ne mogu da provalim sta...
U sustini to jeste vredno truda. U jednom trenutku ce Web servisi doci do nivoa da ce biti mnogo komplikovaniji i marketabilniji. Onda ce im biti potreban i help generator. A ako je za to potrebno cuvati samo jedan file - code a ne i redundantnu dokumentaciju, to ce mnogo da olaksa posao.
Pozdrav.

Odgovor na temu

twister

Član broj: 735
Poruke: 147
*.sbb.co.yu

Profil

Re: Dokumentacija Web Servisa

^{10.08.2003. u 15:41 - pre 252 meseci}

Moda ti odgovara sledece resenje...

Tools/Bulid Comment Web Pages

Ova opcija kupi sve xml komentare iz source-a i pravi dokumentaciju. Pogledaj MSDN (XML documentation, i sl.). Mozes opisati metode, parametre, i ostalo. Odlicna stvar.

Kada neko otvori .asmx stranu, najpre se ispise tvoj kratak opis web service-a, potom ide ono automatski generisano. U tom opisu navedi link ka stranici na kojoj se nalazi dokumentacija.

Da budem iskren, nisam probao ovo da uradim, ali XML dokumentacija je fenomenalna stvar.

Odgovor na temu

DanN
Dan Ninic
Chicago, USA

Član broj: 12625
Poruke: 8
140.212.205.*

Profil

Re: Dokumentacija Web Servisa

^{11.08.2003. u 20:06 - pre 252 meseci}

Ja sam se isto ponadao da je resenje za moj problem "Tools/Build Comment Web Pages". Medjutim, postoje dva problema sa tom opcijom. Kao prvo, prodrzava samo C#, a ne i VB, a ono sto trenutno imam je napisano u VB-u, a drugo, cini mi se da nemam dovoljno kontrole za to sta ce taj bilder da komentarise. On napravi dokumentaciju za sve elemente, dok bih ja hteo da predstavim helpom samo ono sto korisnik vidi, odnosno same servise/metode/operacije i njihove argumente, a ne i internu strukturu. Ovo je super sredstvo za izradu dokumentacije (kada se koristi C#).
Hvala!

Odgovor na temu