Page History: How to create webservice documentation using techwriter

Compare Page Revisions

4 3 2 1 0 Current 4 3 2 1 0

« Older Revision - Back to Page History - Current Revision

Page Revision: 2013/06/13 12:53

installeer WCFExtras via nuget
markeer je soap service interface met een [XmlComments] attribuut
zorg er voor dat "xml documentation file" is aangevinkt in je project properties onder build
je kan nu je soap service interface opmaken met de gebruikelijke dotnet xml comments.
start de service (al dan niet lokaal)


start een nieuw techwriter soap service project
voer de url naar de wsdl van de service in (∼/servicenaam.svc?wsdl) merge de xsd's

zet de volgende filters aan:

• Methods (alles)
• Complex Types (alles)
• Simple Types (alle enumeraties)
• Elements (alle return values van Methods, tip van de week, gebruik een filter pattern :)

zet de volgende options aan:

• web service
  • methods
    • Description
    • Parameter summary
    • Return Value
    • Output

zet de volgende opties uit

• Elements
  • Description
  • Remarks
  • Example
• Attributes
  • Remarks
• Complex types
  • Remarks
  • Derived By
• Simple Types
  • Remarks
  • Derived By

genereer een webpagina

bewerk de webpagina als volgt: vervang de inline css door:

code

zoek en vervang de volgende tekens

• [ door (
• ] door )

plak de hele zwik in een wikipagina