Expose les API Web service

Cela dépend si vous êtes ou non à l'aide de SAVON ou de REPOS. Le SAVON est plus restrictive; en conséquence, il est plus probable que vous aurez un fichier WSDL pour générer les classes de l'interface avec l'API.

D'autre part, si vous utilisez REPOS, tout en exposant une bonne URI serait considérée comme suffisante pour répondre à la contrainte d'un service web RESTful avoir une interface uniforme.

RESTE a tendance à de plus en plus de terrain au cours de SAVON, car il est permissive le style architectural. Je préfère cette méthode, et je recommanderais cette méthode si vous êtes nouveau à développer des services web.

En fonction du langage que vous utilisez, je suis en supposant que Java, vous pouvez utiliser Restlets ou au Printemps 3.0 de REPOS du cadre pour vous aider à construire un service web RESTful. Ces outils vraiment rendre votre travail beaucoup plus facile et vous aider à vous conformer à la 6 Contraintes d'un Service Web RESTful et de répondre à la 4 Objectifs Principaux.

Mise à JOUR:

En supposant que vous avez déjà existants, le code orienté objet, et en supposant que vous souhaitez exposer que le code comme une API REST, à l'aide de Spring MVC 3.0, créer un Contrôleur de la sous-classe qui va s'enrouler autour de votre package existant:

Exemple OBTENIR:

Ressource: Javadoc Jackson ObjectMapper POJO/JSON Marshaller

 //this is the wrapper around your existing Java packages.  
 @Controller
 public class UserController {

     protected static final DATA_TYPE = "json";

     //In REST, GET method is used to retrieve data with no side effects, 
         //meaning that no changes are made to the data on the server.
     @RequestMapping(value="/users/{username}", method=RequestMethod.GET)
     public void getUserData(@PathVariable("username") String userName, Model model) {

         //this is your existing class
         UserDataService userDataService = new UserDataService();

         //assume you have a class User, and getUserDetails gives you that POJO object.
         User user = userDataService.getUserDetails(username);


         //marshal the User object to JSON, using Jackson, and write as output in response
         ObjectMapper mapper = new ObjectMapper();
         mapper.writeValue(response.getWriter(), user);

     }
 }

 //assume you have an existing POJO class called User
 class User implements Serializable {

     String username;
     String age;
     String birthday;
     String mood;

     String getMood() { return this.mood; }
     String getBirthday() { return this.birthday; }
     String getAge() { return this.age; }
     String getUsername() { return this.username; }

     String setMood(String mood) { this.mood = mood; }
     String setBirthday(String birthday) { this.birthday = birthday; }
     String setAge(String age) { this.age = age; }
     String setUsername(String username) { this.username = username; }
}

Demande:

http://api.example.com:8080/users/jmort253/

Réponse:

{ 
    "username":"jmort253",
    "mood":"good",
    "age":"not too old and not too young",
    "birthday","Jan 1, 1900"
}

XML au lieu de JSON:

La principale différence entre le retour du XML et le retour JSON est dans le marshaller utilisé. À l'aide de javax.xml.bind.les annotations, vous pouvez placer des annotations sur la classe POJO de sorte que le marshaller pouvez le convertir en XML, vous libérer de l'détails de l'avoir à la main le code XML à la main:

À l'aide de javax.xml.bind.les annotations pour convertir des Objets Java pour XML et XSD. Cette ressource explique aussi comment générer le Schéma XML, si vous jugez que comme une exigence à votre service Web REST.

 @XmlRootElement
 class User implements Serializable {

     String username;
     String age;
     String birthday;
     String mood;

     String getMood() { return this.mood; }
     String getBirthday() { return this.birthday; }
     String getAge() { return this.age; }
     String getUsername() { return this.username; }

     String setMood(String mood) { this.mood = mood; }
     String setBirthday(String birthday) { this.birthday = birthday; }
     String setAge(String age) { this.age = age; }
     String setUsername(String username) { this.username = username; }
}

Au lieu d'utiliser le Jackson de l'API de ObjectMapper classe de maréchal de la classe POJO en JSON, utilisez le javax.xml.bind.annotations paquet à la place de ObjectMapper:

JAXBContext context = JAXBContext.newInstance(User.class);
Marshaller marshaller = context.createMarshaller();

//pretty print XML
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); 
marshaller.marshal(user, System.out);

Côté des autres ressources, cet article présente quelques exemples d'utilisation de JAXB pour désérialiser une liste de tableaux de POJO objets au format XML.

Ma dernière suggestion lorsque vous travaillez sur le service Web REST wrappers est de définir vos niveaux d'enregistrement pour "TOUS" ou "DEBUG". Je trouve que cela m'aide plus facilement à déterminer la cause racine de tous les problèmes que je face lors de la configuration d'un service Web. Les bibliothèques elles-mêmes de sortie utile messages de débogage pour vous aider à résoudre les problèmes de configuration, tels que les dépendances manquantes, manque d'annotations, et d'autres questions que vous aurez probablement la chance de rencontrer lors de contacts avec la conversion en XML/JSON processus ou dans la configuration de Spring 3.0.

Une fois que vous êtes interfaces uniformes sont d'installation et vous pouvez faire des requêtes GET et de recevoir des réponses, vous pouvez ensuite définir les niveaux de journalisation de retour à la précédente INFO ou AVERTIR les niveaux.

OriginalL'auteur jmort253