SOAP --Interfacce Soap

Il documento di interfaccia soap fornisce la documentazione ad uso utente necessaria a chi deve utilizzare l'interfaccia:

1. il nome
2. la descrizione
3. il namespace uri della domanda e della risposta
4. uri dei dtd della domanda e della risposta
5. uri degli xml Schema della domanda e della risposta
6. i metodi ammessi
7. il formato della domanda
8. il formato della risposta
9. il tracciato con la documentazione dei campi, che contiene anche i campi sui quali sono ammessi degli xref
10. i campi sui quali sono ammessi degli href, solo per Cooked
11. validazioni ed errori (se previsti), solo per Cooked

La documentazione viene prodotta a partire dal file sgml che descrive l'interfaccia. Gli output previsti sono html e tex.

DTD, XML Schema e namespace

Per ragioni di chiarezza documentativa e per limiti strutturali dei DTD, la domanda e la risposta vengono descritte in DTD e XML Schema separati, di conseguenza anche i namespace corrispondenti sono separati.

I namespace hanno il nome seguito da ".i." per l'input e ".o." per l'output. I namespace hanno il suffisso".xsd", in modo da coincidere con l'URI dello schema. Gli URI dei DTD e prodotti dal namespace URI sostituendo il suffisso ".xsd" con ".dtd".

SOAP -- Testata del documento

Campo	Annotazioni
DTD	"SOAP"
DCL	CLA
Name	Nome dell'interfaccia
Title	Descrizione breve della interfaccia
System	Sistema a cui appartiene
SourceFile	Nome del sorgente nel quale si trova la definizione

DAT -- Autore e Revisione

Campo	Annotazioni
Author	Autore. Si usa un formato normale o meglio il formato di posta
Date Composed	Data di creazione del documento.
Date Changed	Data di ultima modifica del documento

DAT -- Corpo del documento

Campo	Annotazioni
Properties	Proprietà dell'interfaccia: Tipo interfaccia: RAW, COOKED
Namespace	Il namespace base dell'interfaccia
DtdIn	URI del DTD di input
DtdOut	URI del DTD di output
SchemaIn	URI dell'XML Schema di input
SchemaOut	URI dell'XML Schema di output
SoapBodyIn	Il contenuto del Soap body di input
SoapBodyOut	Il contenuto del Soap body di output
Methods	La lista dei metodi previsti dall'interfaccia
Body	Descrizione lunga dell'elemento. Testo Ricco.
Decl	Dichiarazioni, si veda DECL -- Markup delle Dichiarazioni